カオナビAPI Ver.2.0のtokenを取得する PHP＋cURLのサンプルプログラム

2024/12/15 2025/01/31

カオナビAPIのtoken、シート情報を取得する PHP＋cURLのサンプルプログラム

　
カオナビAPI Ver.2.0の tokenとシートの情報を PHPの cURLを使用して取得するサンプルプログラムを作りました。
　
カオナビ API Ver.2.0 マニュアル
https://developer.kaonavi.jp/api/v2.0/index.html
　
カオナビAPI Ver.2.0のマニュアルですが、「Request samples」には、コマンドラインで実行する cURLのサンプルコマンドはありましたが、PHPのプログラムとして cURLを組み込む場合のサンプルプログラムがありませんでしたので作成してみました。
　
ただ、この記事は下記の条件を満たす方向けになりますので、非常にターゲットは狭いであろうと思っています。
・カオナビ APIを使用する方
・PHPで作成する方
・cURLで作成する方
　
　

PHPの cURLを使ってカオナビAPIの tokenを取得するサンプルプログラム

// 「カオナビ」APIで使用する情報を設定
$url = "https://api.kaonavi.jp/api/v2.0/token";
$username = "dummy_consumer_key";      // 各自の情報を設定
$password = "dummy_consumer_secret";   // 各自の情報を設定
$postData =  ["grant_type" => "client_credentials"];

// cURLを実行
$getCurlRes = getCurl($url, $username, $password, $postData);

// cURLの実行結果を取得
$token = $getCurlRes["access_token"];
print_r($token);


// cURLを利用して APIにアクセスし結果を取得する関数
function getCurl($url=null,$username=null,$password=null,$postData=null,$headerData=null){
  $option = [
    CURLOPT_RETURNTRANSFER => true, //文字列として返す
    CURLOPT_TIMEOUT        => 3000, // タイムアウト時間
  ];

  // 認証するための ID、PASS（KEY、SECRET）がある場合はそれを指定
  if($username && $password){
    $option[CURLOPT_USERPWD] = $username . ":" . $password;
  }

  // headerの指定がある場合はそれを指定
  if($headerData){
    $option[CURLOPT_HTTPHEADER] = $headerData;
  }

  // POST する値がある場合はそれを指定
  if($postData){
    $option[CURLOPT_POSTFIELDS] = $postData;
  }

  // cURLのセッションを初期化しオプションを指定
  $ch = curl_init($url);
  curl_setopt_array($ch, $option);

  // cURLを実行
  $json     = curl_exec($ch);

  // 実行結果の各値を取得
  $info     = curl_getinfo($ch);
  $errorNo  = curl_errno($ch);
  $errorMsg = curl_error($ch);

  // cURLの実行結果を判定
  if ($errorNo !== CURLE_OK) {
    // 「CURLE_OK（0）」以外のエラーコード
    // エラーコードによって処理を分岐する場合はここに分岐処理を作成する
    return "error";
  }

  // ステータスコードを判定
  if ($info['http_code'] !== 200) {
    // 200以外のステータスコードは正常な値を取得できていないためエラー処理をする
    return "error";
  }

  // 実行結果は JSON形式で取得するため配列に変換して戻す
  return json_decode($json, true);
}

// 「カオナビ」APIで使用する情報を設定

$url = "https://api.kaonavi.jp/api/v2.0/token";

$username = "dummy_consumer_key"; // 各自の情報を設定

$password = "dummy_consumer_secret"; // 各自の情報を設定

$postData = ["grant_type" => "client_credentials"];

// cURLを実行

$getCurlRes = getCurl($url, $username, $password, $postData);

// cURLの実行結果を取得

$token = $getCurlRes["access_token"];

print_r($token);

// cURLを利用して APIにアクセスし結果を取得する関数

function getCurl($url=null,$username=null,$password=null,$postData=null,$headerData=null){

$option = [

CURLOPT_RETURNTRANSFER => true, //文字列として返す

CURLOPT_TIMEOUT => 3000, // タイムアウト時間

];

// 認証するための ID、PASS（KEY、SECRET）がある場合はそれを指定

if($username && $password){

$option[CURLOPT_USERPWD] = $username . ":" . $password;

}

// headerの指定がある場合はそれを指定

if($headerData){

$option[CURLOPT_HTTPHEADER] = $headerData;

}

// POST する値がある場合はそれを指定

if($postData){

$option[CURLOPT_POSTFIELDS] = $postData;

}

// cURLのセッションを初期化しオプションを指定

$ch = curl_init($url);

curl_setopt_array($ch, $option);

// cURLを実行

$json = curl_exec($ch);

// 実行結果の各値を取得

$info = curl_getinfo($ch);

$errorNo = curl_errno($ch);

$errorMsg = curl_error($ch);

// cURLの実行結果を判定

if ($errorNo !== CURLE_OK) {

// 「CURLE_OK（0）」以外のエラーコード

// エラーコードによって処理を分岐する場合はここに分岐処理を作成する

return "error";

}

// ステータスコードを判定

if ($info['http_code'] !== 200) {

// 200以外のステータスコードは正常な値を取得できていないためエラー処理をする

return "error";

}

// 実行結果は JSON形式で取得するため配列に変換して戻す

return json_decode($json, true);

}

　
実際に分かってしまえばシンプルなソースになりますが、cURLのオプションとして「CURLOPT_USERPWD」や「CURLOPT_POSTFIELDS」を指定する点が分かりにくかったですね。
　
　

cURLのオプションの「CURLOPT_USERPWD」「CURLOPT_POSTFIELDS」

　
その cURLのオプションの「CURLOPT_USERPWD」「CURLOPT_POSTFIELDS」や、それ以外のオプションについて詳細を確認したい場合は、下記の PHPマニュアルの「curl_setopt」を参照してください。
https://www.php.net/manual/ja/function.curl-setopt.php
　
　

cURLを実行した際に発生するエラーナンバー

　
cURLを利用して APIにアクセスする処理は「getCurl」として関数化していますので、カオナビ API以外の APIへアクセスする際も汎用的に使用できるかと思います。
　
その際「$errorNo = curl_errno($ch);」で取得しているエラーナンバーとしてどのような値があるのかについて詳細を確認したい場合は、下記の PHPマニュアルの「curl_errno」を参照してください。
https://www.php.net/manual/ja/function.curl-errno.php
　
　
また、上記のサンプルプログラムは、httpのレスポンスとして受信するヘッダ情報を元にエラー処理を分岐させるような処理は作成していません。
もし、それらを実装したい方は下記の記事が参考になるかと思います。
https://ondotori.webstorage.jp/docs/api/reference/api_sample.html
　
　
また、cURLの関数に関しては下記に改めて解説した記事を書きましたので、併せて参考にしてください。
「PHPで APIにアクセスする際などに使用する cURLのサンプルプログラム」
　
　

　
カオナビ APIの「Request samples」として Linux系（Mac）でコマンドで実行する際のサンプルとして下記が提示してあります。
　

curl -X POST https://api.kaonavi.jp/api/v2.0/token \
  -u 'dummy_consumer_key:dummy_consumer_secret' \
  -H 'Content-Type: application/x-www-form-urlencoded;charset=UTF-8' \
  -d 'grant_type=client_credentials'

curl -X POST https://api.kaonavi.jp/api/v2.0/token \

-u 'dummy_consumer_key:dummy_consumer_secret' \

-H 'Content-Type: application/x-www-form-urlencoded;charset=UTF-8' \

-d 'grant_type=client_credentials'

　
cURLのコマンドのオプションとして記述がある「-X」「-u」「-H」「-d」はそれぞれ下記の意味になっています。
　
「-X」
HTTPメソッドの指定で「POST」「GET」などを指定する
　
「-u」
「--user」と記述することもできて、ユーザID、PASSを指定する
ID、PASSは「:（コロン）」で区切る
　
「-H」
HTTPヘッダーを指定する
「-head」「--head」と記述することもできる
　
「-d」
HTTP Bodyにパラメーターを設定して POSTする場合の値を指定する
　
これらについては下記のサイトを参考にしています。
https://qiita.com/shtnkgm/items/45b4cd274fa813d29539
　
　
ちなみに、Linux（Mac）系では、それぞれの値を囲むのは「’（シングルクォート）」「”（ダブルクォート）」のどちらを使用しても問題ありません。
ですが、Windows系では「’（シングルクォート）」を使用すると正しく処理が実行されずにエラーになりますので注意が必要です。「”（ダブルクォート）」を使用しましょう。
　
　

先の項目で取得した Tokenを利用してカオナビAPIのシートのレコードを取得するサンプルプログラム

　
Tokenを取得したのち、その Tokenを利用して、登録してあるシートのレコードを取得する処理は下記のようになります。
　

// 「カオナビ」APIで使用する情報を設定
$url = "https://api.kaonavi.jp/api/v2.0/sheets/9999";  // 9999 の部分は取得対象のシートIDを指定
$headerData = [
  "Content-Type: application/json",
  "Kaonavi-Token: " . $getCurlRes["access_token"],  // Tokenは 前項で取得した Tokenを指定する
];

// cURLを実行（cURLは Tokenを取得したときに使用した関数を使用）
$getCurlRes = getCurl($url, "", "", "", $headerData);

// cURLの実行結果を取得
$token = $getCurlRes["access_token"];
print_r($getCurlRes);

// 「カオナビ」APIで使用する情報を設定

$url = "https://api.kaonavi.jp/api/v2.0/sheets/9999"; // 9999 の部分は取得対象のシートIDを指定

$headerData = [

"Content-Type: application/json",

"Kaonavi-Token: " . $getCurlRes["access_token"], // Tokenは前項で取得した Tokenを指定する

];

// cURLを実行（cURLは Tokenを取得したときに使用した関数を使用）

$getCurlRes = getCurl($url, "", "", "", $headerData);

// cURLの実行結果を取得

$token = $getCurlRes["access_token"];

print_r($getCurlRes);

　
ヘッダー情報に前項で取得した Tokenを指定して、cURLでアクセスすることでシート情報を取得することができます。
　
また、この処理で取得するシートの情報は結構階層が多い多段階の配列になっています。
そのため、「print_r」「var_export」などを使用して配列の構造を表示させながら、必要な項目の値を取得するといいでしょう。

- PHP・Smarty・ECCUBE

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: JSON形式の値を配列形式に変換・PHPでは json_decode()、json_encode()

JSONとは「JavaScript Object Notation」の略でテキストベースのデータフォーマット。JSONの値をPHPで配列に変換するWebツールの紹介とその処理「json_encode()」「json_decode()」関数の解説。

: ECCUBEを開発環境から本番ドメインに変更でエラーが・パス変更について

レンタルサーバでサーバ会社から割り当てられたURLで開発し、本番公開時にドメインを当てたらエラーが！そんな場合の対処方法の解説。対処方法は簡単ですが管理画面からは対応不可。

: 乱数発生器（パスワード生成サービス）がバージョンアップで高速化！

乱数やパスワードを生成する乱数発生器を高速化！重複しない10桁、20桁の文字列を10万件、20万件と生成することも可能！イベントのキャンペーンのシリアルコードなどにも利用可能！

: ECCUBEの商品一覧ページのSEO対策！rel=”next”　rel=”prev”を設定

Googleは関連あるページはその旨明示するよう求めています。ECCUBEの商品一覧ページでその求めに応じるための「rel=”next”」「rel=”prev”」について解説します。

: ob_start、ob_get_contents関数でPHPの標準出力をバッファリング・変数に代入

標準出力をバッファリングし変数に代入することができるob_start()関数の解説。include()の処理をバッファリングすることで自由な場所に処理を記述することが可能。

: ECCUBEでアップロードできない。upload_max_filesizeを設定する場所

テンプレートをアップロードする際に発生するエラー「テンプレートファイルがアップロードされていません」の対処方法。これはファイル容量の制限に引っかかっています。

: 配列の値をテキスト表示する際に「、」でつなげるときの処理方法の一例

配列の値を「、」でつないで出力する際、単純にforeachで繰り返し処理をすると「イヌ、サル、キジ、」となるが文字列最後の「、」を出力しない方法を3つ解説している。

: PHPのデバッグで使う print_r、var_dump、var_exportの動作の違い

PHPのデバッグ等で変数や配列の中身を確認するために使用する関数print_r、var_dump、var_exportの動作の違い、仕様の違いについて確認した。var_exportがオススメ。

: PHPで配列の値をダブルクオーテーションで囲んでimplodeでカンマ区切りにする方法

PHPで配列の値を、preg_replace関数でクォーテーションで囲み、implode関数で「,（カンマ）」で区切ってテキスト化する方法。この方法であれば配列が空でも分岐の処理は必要なし！

: QRコード（二次元バーコード）作成サービスを公開

QRコード（二次元バーコード）を生成するサービス。QRコードにする文字列を入力するだけで QRコードが簡単に作れる。オプションとして、画像サイズ、余白サイズ、エラー訂正レベルがある。

PREV: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説
NEXT: PHPで APIにアクセスする際などに使用する cURLのサンプルプログラム

日	月	火	水	木	金	土
					1	2
3	4	5	6	7	8	9
10	11	12	13	14	15	16
17	18	19	20	21	22	23
24	25	26	27	28	29	30
31

カオナビAPI Ver.2.0のtokenを取得する PHP＋cURLのサンプルプログラム

カオナビAPIのtoken、シート情報を取得する PHP＋cURLのサンプルプログラム

PHPの cURLを使ってカオナビAPIの tokenを取得するサンプルプログラム

cURLのオプションの「CURLOPT_USERPWD」「CURLOPT_POSTFIELDS」

cURLを実行した際に発生するエラーナンバー

先の項目で取得した Tokenを利用してカオナビAPIのシートのレコードを取得するサンプルプログラム

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

JSON形式の値を配列形式に変換・PHPでは json_decode()、json_encode()

ECCUBEを開発環境から本番ドメインに変更でエラーが・パス変更について

乱数発生器（パスワード生成サービス）がバージョンアップで高速化！

ECCUBEの商品一覧ページのSEO対策！rel=”next”　rel=”prev”を設定

ob_start、ob_get_contents関数でPHPの標準出力をバッファリング・変数に代入

ECCUBEでアップロードできない。upload_max_filesizeを設定する場所

配列の値をテキスト表示する際に「、」でつなげるときの処理方法の一例

PHPのデバッグで使う print_r、var_dump、var_exportの動作の違い

PHPで配列の値をダブルクオーテーションで囲んでimplodeでカンマ区切りにする方法

QRコード（二次元バーコード）作成サービスを公開

WordPress投稿にPHPを記述するショートコードの使い方add_shortcode

コピーコンテンツ対策.htaccessで直リンク禁止しリダイレクトで対応

評価点投票プラグイン10個を比較！WordPressで口コミサイトを構築

BackWPupでバックアップ・リストア（復元）の具体的手順

コンパクトキーボード・KEK-EA9AU・FKB1420の魅力