PHPで APIにアクセスする際などに使用する cURLのサンプルプログラム

2024/12/16 2025/01/31

PHPで APIにアクセスする際などに使用する cURLのサンプルプログラム

　
カオナビAPI Ver.2.0のtokenを取得する PHP＋cURLのサンプルプログラム
上記のカオナビ APIにアクセスする cURLの関数を作成しました。
　
上記の記事でも少し解説をしていますが、あくまでもカオナビ APIにアクセスするための記事ですので、こちらの記事では改めて、cURLの関数について解説をしようと思います。
　
　

cURLには多様なオプションが用意されている

　
cURLのオプションは多様で、さまざまなオプションが用意されています。
ここでは、APIにアクセスするときに使用することがあるオプションを実装した関数として作成してみました。
　
　

// cURLを利用して APIにアクセスし結果を取得する関数
function getCurl($url = null, $username = null, $password = null, $postData = null, $headerData = null){

  // パラメータのチェック
  if(!$url){
    return "error";
  }

  // 初期設定のオプションを指定する
  $option = [
    CURLOPT_RETURNTRANSFER => true,   // 文字列として返す設定
    CURLOPT_TIMEOUT        => 3000,   // タイムアウト時間を設定
  ];

  // Token取得など認証のための 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を利用して APIにアクセスし結果を取得する関数

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

// パラメータのチェック

if(!$url){

return "error";

}

// 初期設定のオプションを指定する

$option = [

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

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

];

// Token取得など認証のための 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);

}

ヘッダー情報を指定する

　
ヘッダー情報は下記のように配列で指定します。
ヘッダー情報を複数指定する場合は、配列の値として追加をしていきます。
　

$headerData = [
  "Content-Type: application/json",
  "Kaonavi-Token: " . $getCurlRes["access_token"],
];

$headerData = [

"Content-Type: application/json",

"Kaonavi-Token: " . $getCurlRes["access_token"],

];

　
カオナビAPIでは、ヘッダー情報に Tokenを指定して送信する方式ですので、上記のように指定します。
　
このほか、ヘッダー情報としては「"X-HTTP-Method-Override: GET"」などを指定する APIもあるかと思います。
　
　

POSTする値を指定する

　
APIにアクセスする際、GET形式で URL内にパラメータを付与する方法もありますが、ID、PASSを送信する際はセキュリティの配慮を行い、POSTで情報を送信する場合もあります。
　
その場合は、POSTで送信する情報を指定しますが、下記のように配列で、キーと値を指定します。
　

$postData = [
  "name" => "山田",
  "kana" => "やまだ",
];

$postData = [

"name" => "山田",

"kana" => "やまだ",

];

「curl_errno()」で取得する「`$errorNo`」の情報を判定する

  // cURLの実行結果を判定
  if ($errorNo !== CURLE_OK) {
    // 「CURLE_OK（0）」以外の場合はエラー
    // エラーコードは下記を参照し、必要に応じて分岐処理を作成する
    return "error";
  }

// cURLの実行結果を判定

if ($errorNo !== CURLE_OK) {

// 「CURLE_OK（0）」以外の場合はエラー

// エラーコードは下記を参照し、必要に応じて分岐処理を作成する

return "error";

}

　
「curl_errno()」で取得する上記の「$errorNo」に入っているエラーコードの詳細は下記のページから確認することができます。
https://www.php.net/manual/ja/function.curl-errno.php
　
エラー内容を見てもらって分かるように、ここで発生するエラーは、指定の URLにアクセスできないというエラーが多数を占めています。
開発段階ではデバッグに役に立つ情報かと思いますが、実運用段階では APIにはアクセスできる前提で動作していますので、エラーがあるか、ないかだけで分岐すれば足りるのではないか、と思います。
実運用段階でのエラーは、APIサーバが落ちているとか、URLが変わったとか、ネットワーク障害が発生したとか、プログラムの処理とは関係ない場合が多数を占めますので、エラーコードをログに残してエラー情報を確認できるようにしておけば、詳細な振り分けはあまり意味はない用意も思います。
　
　

「curl_getinfo()」で取得するステータスコードを判定する

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

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

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

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

return "error";

}

　
前項の「$errorNo」に入っているエラー情報と異なり、上記のステータスコードによるエラー判定は、APIが返答するエラーコードになります。（APIにはアクセスができた上でのエラーになります。）
　
APIにアクセスし、正常に情報が取得できた場合はステータスコード「200」が返ってきますので、その場合は正常処理とします。
　
それ以外のエラー内容については、API毎に異なりますので、API毎にそれぞれあった振り分け処理を作成する必要があるかと思います。
　
APIにアクセスするプログラムの性質にもよると思いますが、ここはエラーコードによってある程度分岐の処理がある方がいいのかと思います。
　
　
今回作成した cURLの関数は、カオナビ APIにアクセスすることを前提に作成したものですが、他の APIにアクセスする際も同じように利用できる場合が多いかと思いますので、必要に応じてカスタマイズして使用していただければ、と思います。

- PHP・Smarty・ECCUBE

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

Message コメントをキャンセル

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

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

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

: フォルダを指定してファイルのパーミッションを変更するプログラム

フォームからフォルダ、パーミッションを指定しパーミッションを変更するサンプルプログラムの解説です。

: 路線・駅検索のために緯度経度からPHPで2点間の距離を計算する処理解説

路線・駅検索の仕組みの構築は大変。それを簡易に実装するために緯度経度を元に距離計算をする仕組みを考案。まずは2点間の距離を計算する仕組みを解説し、距離計算にまつわる関連技術も紹介。

: PHPで月末から1ヶ月後「+1 month」を算出すると想定する日付にならない場合がある

PHPでは月末の1ヶ月後が想定した日付にならない場合がある。原因はバグではなくPHPの1ヶ月後の定義によるもの。なので必要とする日付を定義しそれに合わせてDateTime、modifyを使用して算出方法を解説している。

: ECCUBEでテンプレートファイルのファイルサイズは10MB以下のものを使用してくださいのエラーが出た場合

テンプレートをアップロードする際にファイルサイズが大きすぎてエラーが表示される際の対処方法解説。パラメータ設定で設定する制限について解説を行っています。

: AdminerはphpMyAdmin代替のデータベース管理ツール

AdminerはphpMyAdminとほぼ同機能のデータベース管理ツール。PHP 1ファイルのため設置が非常に簡単で軽快に動作し、phpMyAdminの置き換えで使うのも問題なし。

: ECCUBEのポイント設定、ポイント付与率を一括で変更する方法解説

ECCUBEの商品個別に設定してあるポイントを一括で変更する方法を解説。ECCUBEには商品個別のポイントを一括して変更する機能がありません。SQLを作成して一括置換！

: PHPでスクレイピング。phpQueryとphp-simple-html-dom-parserの比較と設置方法

「PHP スクレイピング」で検索すると「phpQuery」ばかりヒットするが、10年以上も放置されている。なので今も開発が続いている「PHP Simple HTML DOM Parser」をオススメする。

: 複数銘柄を指定して株価チャートを一覧するツール公開

入力銘柄の5日間、3か月間、6か月間、1年間、2年間の株価チャートを一覧表示しますのでチャートで売買判断をするのに最適です。

: sleepの秒指定は整数のみなので1.5秒はsleep、usleepを組み合わせる

PHPのプログラム処理を遅延させる「sleep()」は整数秒単位。「usleep()」は1秒未満のマイクロ秒単位。では「1.5」秒はどう表現するのか。「sleep()」「usleep()」を組み合わせる。その解説。

PREV: カオナビAPI Ver.2.0のtokenを取得する PHP＋cURLのサンプルプログラム
NEXT: CakePHP5系で認証機能のAuthenticationプラグインをインストール・エラー発生注意

日	月	火	水	木	金	土
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

PHPで APIにアクセスする際などに使用する cURLのサンプルプログラム

PHPで APIにアクセスする際などに使用する cURLのサンプルプログラム

cURLには多様なオプションが用意されている

ヘッダー情報を指定する

POSTする値を指定する

「curl_errno()」で取得する「`$errorNo`」の情報を判定する

「curl_getinfo()」で取得するステータスコードを判定する

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

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

フォルダを指定してファイルのパーミッションを変更するプログラム

路線・駅検索のために緯度経度からPHPで2点間の距離を計算する処理解説

PHPで月末から1ヶ月後「+1 month」を算出すると想定する日付にならない場合がある

ECCUBEでテンプレートファイルのファイルサイズは10MB以下のものを使用してくださいのエラーが出た場合

AdminerはphpMyAdmin代替のデータベース管理ツール

ECCUBEのポイント設定、ポイント付与率を一括で変更する方法解説

PHPでスクレイピング。phpQueryとphp-simple-html-dom-parserの比較と設置方法

複数銘柄を指定して株価チャートを一覧するツール公開

sleepの秒指定は整数のみなので1.5秒はsleep、usleepを組み合わせる

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

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

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

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

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

PHPで APIにアクセスする際などに使用する cURLのサンプルプログラム

PHPで APIにアクセスする際などに使用する cURLのサンプルプログラム

cURLには多様なオプションが用意されている

ヘッダー情報を指定する

POSTする値を指定する

「curl_errno()」で取得する「$errorNo」の情報を判定する

「curl_getinfo()」で取得するステータスコードを判定する

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

「curl_errno()」で取得する「`$errorNo`」の情報を判定する