PHPのcURLでAPIやWebサイトへのアクセス方法。file_get_contentsとの比較

2020/01/26 2020/02/08

PHPの cURLで APIや Webサイトにアクセスする方法

file_get_contentsもあるけど cURLの方が細かな制御が可能

　
PHPのプログラムの処理の一つとして
・APIにアクセスをする
・Webスクレイピングをする
という場合には、PHPのプログラムから Webサイトにアクセスをする必要があります。
　
そんなときに「cURL（カール）」を使って Webサイトにアクセスする方法を解説します。
　
　
PHPから Webサイトにアクセスする場合は「file_get_contents()」を使うと簡単にページの情報を取得できますので便利です。
　
ですが、下記のサイトにあるように、「file_get_contents()」では厳密な制御が難しいという難点があります。
https://qiita.com/shinkuFencer/items/d7546c8cbf3bbe86dab8
　
個人的なツールを作成するときには file_get_contents()でも問題なくても、Webサービスを作成する場合にはトラブルにつながる可能性があるわけです。
　
そんなわけで、PHPから Webサイトにアクセスするときは、cURLを利用することをおすすめします。
　
　

cURLで Webサイトから情報を取得する関数の一例

　
cURLを利用して Webサイトにアクセスして、そのレスポンスを取得する関数としては下記のように記述できます。
先に紹介したサイトのサンプルソースをほぼそのままですが。
　

public function getApiDataCurl($url){

    $option = [
        CURLOPT_RETURNTRANSFER => true, // 文字列として返す
        CURLOPT_TIMEOUT        => 30,   // タイムアウト時間
    ];

    $ch = curl_init($url);
    curl_setopt_array($ch, $option);

    $body     = curl_exec($ch);
    $info     = curl_getinfo($ch);
    $errorNo  = curl_errno($ch);
    $errorMsg = curl_error($ch);

    // 「CURLE_OK」以外はエラーなのでエラー情報を返す
    if ($errorNo !== CURLE_OK) {
        // 詳しくエラーハンドリングしたい場合はerrorNoで確認
        // タイムアウトの場合はCURLE_OPERATION_TIMEDOUT
        return $errorNo . " : " . $errorMsg;
    }

    // 200以外のステータスコードは失敗なのでそのステータスコードを返す
    if ($info['http_code'] !== 200) {
        return $info['http_code'];
    }

    $responseArray = json_decode($body, true);    // JSON を配列に変換

    return $responseArray;
}

public function getApiDataCurl($url){

$option = [

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

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

];

$ch = curl_init($url);

curl_setopt_array($ch, $option);

$body = curl_exec($ch);

$info = curl_getinfo($ch);

$errorNo = curl_errno($ch);

$errorMsg = curl_error($ch);

// 「CURLE_OK」以外はエラーなのでエラー情報を返す

if ($errorNo !== CURLE_OK) {

// 詳しくエラーハンドリングしたい場合はerrorNoで確認

// タイムアウトの場合はCURLE_OPERATION_TIMEDOUT

return $errorNo . " : " . $errorMsg;

}

// 200以外のステータスコードは失敗なのでそのステータスコードを返す

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

return $info['http_code'];

}

$responseArray = json_decode($body, true); // JSON を配列に変換

return $responseArray;

}

　
アクセスする URLをパラメータとして付与して関数を呼び出します。
JSON形式で結果を返してくれる APIにアクセスしたと想定すると、結果を配列で取り出すことができる、という仕組みのものです。
　
　

SSLでアクセス、UserAgentが必要なページへの対応を行った cURLの関数

　
ですが、このサンプルソースでは、2つの条件では正常に情報を取得することが出来ません。
　
・SSLでアクセスする必要があるページ
・UserAgentを必要とするページ
　
　
最近は、多くのサイトが SSLに対応してきまして、SSLでのみアクセス可能なサイトも増えてきました。
そのため、SSLでのアクセス対応は必須といえます。
　
また、自動プログラムによるアクセスやスクレイピングされることの対策として、UserAgentが設定されていない状態でのアクセスを拒否するサイトも存在しています。
　
というわけで、この 2つを対策してみましょう。
　
　
また、先のソースは APIにアクセスして JSONをレスポンスとして取得する想定でしたが、単純に HTMLを取得する場合もあるでしょうから、それを分岐した処理も加えてみます。（さらに、header情報のみを取得する処理も加えてみます。）
　
　

// APIを呼び出し、結果を受け取る処理（URLにアクセスしその結果を取得する処理）
// $url         ：APIの URI（アクセスする URL）
// $responseType：受け取る結果のタイプ（header、html、json）
public function getApiDataCurl($url, $responseType = "html" ){

    if ( $responseType == "header" ) {
        $option = [
            CURLOPT_RETURNTRANSFER => true,  // 文字列として返す
            CURLOPT_TIMEOUT        => 30,    // タイムアウト時間
            CURLOPT_HEADER         => true,  
            CURLOPT_NOBODY         => true,  
            CURLOPT_SSL_VERIFYPEER => false, // サーバ証明書の検証をしない
        ];
    } else {
        $option = [
            CURLOPT_RETURNTRANSFER => true,  // 文字列として返す
            CURLOPT_TIMEOUT        => 30,    // タイムアウト時間
            CURLOPT_SSL_VERIFYPEER => false, // サーバ証明書の検証をしない
            CURLOPT_USERAGENT      => USER_AGENT_TEXT,  // UserAgentを指定
        ];
    }

    $ch = curl_init($url);
    curl_setopt_array($ch, $option);

    $body     = curl_exec($ch);
    $info     = curl_getinfo($ch);
    $errorNo  = curl_errno($ch);
    $errorMsg = curl_error($ch);

    // 「CURLE_OK」以外はエラーなのでエラー情報を返す
    if ($errorNo !== CURLE_OK) {
        // 詳しくエラーハンドリングしたい場合はerrorNoで確認
        // タイムアウトの場合はCURLE_OPERATION_TIMEDOUT
        return $errorNo . " : " . $errorMsg;
    }

    // 200以外のステータスコードは失敗なのでそのステータスコードを返す
    if ($info['http_code'] !== 200) {
        return $info['http_code'];
    }

    // headerのみ取得
    if($responseType == "header") {
        $responseArray = explode("\n", $body);                   // 行に分割
        $responseArray = array_map('trim', $responseArray);      // 各行にtrim()をかける
        $responseArray = array_filter($responseArray, 'strlen'); // 文字数が0の行を取り除く
        $responseArray = array_values($responseArray);           // キーを連番に振りなおす

    // HTMLの本体を取得
    } elseif($responseType == "html"){
        $responseArray = $body;

    // JSONで取得した情報を配列に変換して取得
    } else {
        $responseArray = json_decode($body, true);     // JSON を配列に変換
    }

    return $responseArray;
}

// APIを呼び出し、結果を受け取る処理（URLにアクセスしその結果を取得する処理）

// $url ：APIの URI（アクセスする URL）

// $responseType：受け取る結果のタイプ（header、html、json）

public function getApiDataCurl($url, $responseType = "html" ){

if ( $responseType == "header" ) {

$option = [

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

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

CURLOPT_HEADER => true,

CURLOPT_NOBODY => true,

CURLOPT_SSL_VERIFYPEER => false, // サーバ証明書の検証をしない

];

} else {

$option = [

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

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

CURLOPT_SSL_VERIFYPEER => false, // サーバ証明書の検証をしない

CURLOPT_USERAGENT => USER_AGENT_TEXT, // UserAgentを指定

];

}

$ch = curl_init($url);

curl_setopt_array($ch, $option);

$body = curl_exec($ch);

$info = curl_getinfo($ch);

$errorNo = curl_errno($ch);

$errorMsg = curl_error($ch);

// 「CURLE_OK」以外はエラーなのでエラー情報を返す

if ($errorNo !== CURLE_OK) {

// 詳しくエラーハンドリングしたい場合はerrorNoで確認

// タイムアウトの場合はCURLE_OPERATION_TIMEDOUT

return $errorNo . " : " . $errorMsg;

}

// 200以外のステータスコードは失敗なのでそのステータスコードを返す

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

return $info['http_code'];

}

// headerのみ取得

if($responseType == "header") {

$responseArray = explode("\n", $body); // 行に分割

$responseArray = array_map('trim', $responseArray); // 各行にtrim()をかける

$responseArray = array_filter($responseArray, 'strlen'); // 文字数が0の行を取り除く

$responseArray = array_values($responseArray); // キーを連番に振りなおす

// HTMLの本体を取得

} elseif($responseType == "html"){

$responseArray = $body;

// JSONで取得した情報を配列に変換して取得

} else {

$responseArray = json_decode($body, true); // JSON を配列に変換

}

return $responseArray;

}

　
　
上記の「CURLOPT_USERAGENT」のパラメータとして指定している「USER_AGENT_TEXT」は、下記のような感じで定数として指定している想定です。
　

// UserAgent
define("USER_AGENT_TEXT", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36"),

1 2	// UserAgent define("USER_AGENT_TEXT", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36"),

SSLでのアクセスが必要なサイトにアクセスしたときのエラー

　
SSLでのアクセスが必要なサイトにアクセスしたときに表示されるエラーの一例は、以下のようになります。
　

77 : error setting certificate verify locations:
  CAfile: C:\xampp\apache\bin\curl-ca-bundle.crt
  CApath: none

77 : error setting certificate verify locations:

CAfile: C:\xampp\apache\bin\curl-ca-bundle.crt

CApath: none

　
SSLでサイトにアクセスする際は、サーバ証明書のチェックを行いますが、上記のエラーは「サーバ証明書がありません」というものです。
そのため、先の設定では、SSLでアクセスする際もサーバ証明書のチェックを行わない、とするものです。
　
　
ですが、サーバ証明書を設置することで本来の SSLアクセスであるサーバ証明書をチェックしながら正常にアクセスをする方法もあります。
　
詳しくは下記の記事などが参考になるかと思います。
https://www.softel.co.jp/blogs/tech/archives/4026
　
　

UserAgentがない状態でサイトにアクセスしたときのエラー

　
UserAgentがない状態でサイトにアクセスしたときのエラーは、サイトによってさまざまです。
そのため、こんなエラーが出ますという表現は意味を持ちませんが、この記事を書くきっかけとなったサイトでは下記のようなエラーがでていました。
　

　
上記のエラーは、「サポート外のブラウザです」ということですので、正しく見ることができるブラウザの UserAgentを指定してみるといいのではないか、と思います。

- PHP・Smarty・ECCUBE

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

Message コメントをキャンセル

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

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

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

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

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

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

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

: 連想配列のキーも値もまとめてhtmlspecialchars()でサニタイズする関数の作成解説

PHPの配列・連想配列のキーと値をまとめてhtmlspecialchars()関数でサニタイズ（無害化、無毒化）を行う関数を作成。連想配列のキーはarray_map()関数でのサニタイズは無理。

: 路線・駅検索をPHPで実装する方法解説。GoogleMapsの緯度経度から計算し検索

路線・駅検索の仕組みの構築は大変。登録する側も最寄り駅が多い場合は大変。なので簡易に実装するため緯度経度に基づき直線距離を計算する処理を考案して実装して、その処理を解説。

: QRコード作成ライブラリ「cakePHP-QR-Code-Helper」をPHPで使うカスタマイズ

CakePHP2用のQRコード作成ライブラリ「cakePHP-QR-Code-Helper」をプレーンのPHPでも使うためのカスタマイズ方法を解説。1ファイルを設置するだけでQRコードが作れるため使い勝手がいい。

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

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

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

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

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

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

: 数値がMySQLのint(11)に保存できない！PHPの変数が本当にint型か確認！

PHPでintegerとdoubleが混在するような計算をする場合は要注意！計算結果が整数値であっても途中で使用する変数にdoubleの値が入っているときは計算結果がintegerではない場合があります。