PHPでCloudflareのAPI経由でキャッシュを削除する

Cloudflareの管理画面でできる機能の多くにはAPIが用意されており、キャッシュの削除もAPI経由で行うことができます。これにより投稿に応じて指定したページのキャッシュをpurgeするといった事が可能です。

自分で処理を作っても良いのですが、どうもCloudflareの公式がPHP用のSDKを作成しているようなのでそちらを使ってみました。

インストール

composer require cloudflare/sdk

Adapterの作成

API接続用のAdapterを初期化します。下記の情報が必要になりますので、Cloudflareのダッシュボードの分かりやすいところに書かれていますのでそちらで確認し、アプリケーションの.env等に設定しておくと良いと思います。

• アカウントのメールアドレス
• API Key
• ZONE ID

色々なAPIがありますが、共通の初期化です。

use Cloudflare\API\Auth\APIKey;
use Cloudflare\API\Adapter\Guzzle;
use Cloudflare\API\Endpoints\Zones;

$key = new APIKey(config('services.cloudflare.email'), config('services.cloudflare.key'));
$adapter = new Guzzle($key);

キャッシュのpurge

キャッシュを削除するにはzonesというエンドポイントの機能を使います。先程のadapterを利用して実行します。

$zones = new Zones($this->adapter);
try {
    $zones->cachePurge(config('services.cloudflare.zone_id'), [$url]);
} catch (\GuzzleHttp\Exception\RequestException $e) {
    \Log::error($e->getMessage());
}

URLのホスト名がおかしかったりすると例外が発生するので適宜エラー処理を行ってください。cachePurgeの戻り値はboolのためレスポンスの詳細は分かりませんが、$zones自体にレスポンスが保存されているのでダンプすれば確認可能です。（成功しているとたいした情報は無いのであまり意味はないです）

僕はなぜかpurgeされずおかしいな、と思っていたらURL指定が間違っていたりしたのですが、Cloudflare的には正常のため特にエラーなども出ないので、そのあたりはしっかりログを残して確認しておいてください。