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 コメントをキャンセル

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

: サーバ移転、PHPバージョンアップでPHPのソースコードが表示される・ショートタグのPHPが動かない

PHPでショートタグを使うのは危険。サーバ移転やバージョンアップで動かなくなる！ソースが丸見え、設定情報流出のリスクが！php.iniのshort_open_tagの設定を再確認。

: PHPで特定の日間の日付を for、strtotimeで表示する

ある特定の間の日付の情報を for文、strtotimeを使って作成し、その解説をしています。

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

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

: ECCUBE2.13.3で商品規格の在庫数が無制限から変更できないバグがある

2.13.3固有のバグである商品規格の在庫数の入力エリアがアクティブにならない不具合を解消する解説です。product_class.tplの2行を修正するだけの簡単対応です。

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

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

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

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

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

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

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

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

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

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

: include、requireのパス指定をdirname(__FILE__)、__DIR__と書く理由

include、requireのパスの指定を dirname(__FILE__)、__DIR__で記述する理由に付いて解説。相対パス、絶対パスを直書き、パスを書かない場合は何が問題かを説明。