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パーミッション変更のchmod関数・モードを変数で指定する方法

パーミッション変更関数であるchmod関数の第二引数、ファイルモードの指定に変数を使う場合は8進数に変換するoctdec関数を使って変換します。

: XML形式の値を配列形式に変換・PHPでは simplexml_load_string()

XMLとは「Extensible Markup Language」の略でテキストベースのデータフォーマット。XMLをPHPで配列に変換するWebツールの紹介とその処理「simplexml_load_string()」関数についての解説。