PHPで APIにアクセスする際などに使用する cURLのサンプルプログラム
2025/01/31
PHPで APIにアクセスする際などに使用する cURLのサンプルプログラム
カオナビAPI Ver.2.0のtokenを取得する PHP+cURLのサンプルプログラム
上記のカオナビ APIにアクセスする cURLの関数を作成しました。
上記の記事でも少し解説をしていますが、あくまでもカオナビ APIにアクセスするための記事ですので、こちらの記事では改めて、cURLの関数について解説をしようと思います。
cURLには多様なオプションが用意されている
cURLのオプションは多様で、さまざまなオプションが用意されています。
ここでは、APIにアクセスするときに使用することがあるオプションを実装した関数として作成してみました。
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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
// 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); } |
ヘッダー情報を指定する
ヘッダー情報は下記のように配列で指定します。
ヘッダー情報を複数指定する場合は、配列の値として追加をしていきます。
1 2 3 4 |
$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で送信する情報を指定しますが、下記のように配列で、キーと値を指定します。
1 2 3 4 |
$postData = [ "name" => "山田", "kana" => "やまだ", ]; |
「curl_errno()」で取得する「$errorNo
」の情報を判定する
1 2 3 4 5 6 |
// 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()」で取得するステータスコードを判定する
1 2 3 4 5 |
// ステータスコードを判定 if ($info['http_code'] !== 200) { // 200以外のステータスコードは正常な値を取得できていないためエラー処理をする return "error"; } |
前項の「$errorNo」に入っているエラー情報と異なり、上記のステータスコードによるエラー判定は、APIが返答するエラーコードになります。(APIにはアクセスができた上でのエラーになります。)
APIにアクセスし、正常に情報が取得できた場合はステータスコード「200」が返ってきますので、その場合は正常処理とします。
それ以外のエラー内容については、API毎に異なりますので、API毎にそれぞれあった振り分け処理を作成する必要があるかと思います。
APIにアクセスするプログラムの性質にもよると思いますが、ここはエラーコードによってある程度分岐の処理がある方がいいのかと思います。
今回作成した cURLの関数は、カオナビ APIにアクセスすることを前提に作成したものですが、他の APIにアクセスする際も同じように利用できる場合が多いかと思いますので、必要に応じてカスタマイズして使用していただければ、と思います。
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
路線・駅検索のために緯度経度からPHPで2点間の距離を計算する処理解説
路線・駅検索の仕組みの構築は大変。それを簡易に実装するために緯度経度を元に距離計算をする仕組みを考案。まずは2点間の距離を計算する仕組みを解説し、距離計算にまつわる関連技術も紹介。
-
-
XML形式の値を配列形式に変換・PHPでは simplexml_load_string()
XMLとは「Extensible Markup Language」の略でテキストベースのデータフォーマット。XMLをPHPで配列に変換するWebツールの紹介とその処理「simplexml_load_string()」関数についての解説。
-
-
include、requireのパス指定をdirname(__FILE__)、__DIR__と書く理由
include、requireのパスの指定を dirname(__FILE__)、__DIR__で記述する理由に付いて解説。相対パス、絶対パスを直書き、パスを書かない場合は何が問題かを説明。
-
-
ECCUBEでアップロードできない。upload_max_filesizeを設定する場所
テンプレートをアップロードする際に発生するエラー「テンプレートファイルがアップロードされていません」の対処方法。これはファイル容量の制限に引っかかっています。
-
-
パーミッション(属性)一括変更ツール・WordPress最適化済
WordPressのパーミッション(属性)を一括変更するツールを作成!ファイル、フォルダのパーミッションが一覧表示でき、ファイルを選んでパーミッションの変更が行えます。
-
-
ECCUBEの問い合わせフォームに任意の値を引数として渡す方法
ECCUBEのお問い合わせフォームに値を固有の情報を送りそれに基づいて処理をする方法を解説。ボタンの設置、受け取り側のテンプレート、プログラムのサンプルソースを提供。
-
-
PHPで1ヵ月前、先月、今月1日、来月末の日付などの算出はDateTimeImmutableを使う
PHPには日時をオブジェクトとして生成する関数「DateTimeImmutable」「DateTime」が用意されている。これを利用して1ヶ月後、月初日、月末日、5日後などを指定して日付を取得できる。
-
-
cURLを利用する際の注意点「
&
」があるURLは「”
」で囲むcURLでURLはダブルクォーテーションで囲む。LinuxでもWindowsでもコマンドでは「&」は意味を持つ文字のためエラー原因になる。クォーテーションは常につけておく方が無難。
-
-
PHPで月末から1ヶ月後「+1 month」を算出すると想定する日付にならない場合がある
PHPでは月末の1ヶ月後が想定した日付にならない場合がある。原因はバグではなくPHPの1ヶ月後の定義によるもの。なので必要とする日付を定義しそれに合わせてDateTime、modifyを使用して算出方法を解説している。
-
-
フォルダを指定してファイルのパーミッションを変更するプログラム
フォームからフォルダ、パーミッションを指定しパーミッションを変更するサンプルプログラムの解説です。