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

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

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

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

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

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

: Smartyのテンプレート内の処理で計算、加工をする方法

Smartyのテンプレート上で変数を計算する、加工する方法を解説します。

: PHPで1ヵ月前、先月、今月1日、来月末の日付などの算出はDateTimeImmutableを使う

PHPには日時をオブジェクトとして生成する関数「DateTimeImmutable」「DateTime」が用意されている。これを利用して1ヶ月後、月初日、月末日、5日後などを指定して日付を取得できる。

: cURLを利用する際の注意点「&」があるURLは「”」で囲む

cURLでURLはダブルクォーテーションで囲む。LinuxでもWindowsでもコマンドでは「＆」は意味を持つ文字のためエラー原因になる。クォーテーションは常につけておく方が無難。

: PHPで正規表現の検証には preg_match_allが便利

PHPで正規表現の検証には preg_match_allが便利です。その便利さの使い方の解説です。

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

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

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

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