Fastly API を Postman 経由で簡単に呼び出す方法

概要

REST API のテストツールである Postman を使って、Fastly API を呼び出す手順を紹介します。curl で叩くよりも楽になるのでオススメです。


Postman とは

REST API のクライアントです。似たようなソフトウェアとしては、Chrome 向けの Advanced REST client などがあります。

GET や POST リクエストの組み立てはもちろん、レスポンスヘッダやボディも見やすく整形してくれるため、REST API のテストに最適なツールです。

f:id:yuu2634:20180226204404p:plain


Postman のセットアップ

以下リンクからダウンロードできます。

www.getpostman.com


基本的な使用方法については、以下の記事が参考になるかと思います。


fastly-postman

Fastly のエンジニアが公開している Postman 連動用のリポジトリです。Postman にインポートし、初期設定をするだけで利用可能です。

github.com


git clone もしくは ZIP ダウンロードで取得しましょう。

f:id:yuu2634:20180226203231p:plain


初期設定

右上の設定ボタンから環境設定画面を開きます。

f:id:yuu2634:20180226204610p:plain


Import から、fastly.postman_*.json の3ファイルをインポート。

f:id:yuu2634:20180226204715p:plain


左下の Globals から、Fastly のアカウント情報を登録します。

f:id:yuu2634:20180226204840p:plain

  • username: ログインユーザ名
  • password: ログインパスワード
  • token: アクセストークン(※)
  • customer_id: Company settings の Company ID
  • user_id: User management のユーザ名の右隣

※アクセストークンの発行手順は こちらの記事 を参照


サービス登録

Fastly 上のサービスを登録していきます。作成されている Fastly をクリック。

f:id:yuu2634:20180228000129p:plain


管理画面の service_id, service_name, version_no を書き写します。

f:id:yuu2634:20180227235928p:plain

f:id:yuu2634:20180227235622p:plain

これで使うための準備が一通り完了しました。


CDN設定を取得する

始めに、API 経由で Request Settings を取得してみます。

  1. 先ほど設定した環境を選択
  2. Collections を開く
  3. 実行したい API (Configuration - Request Settings の GET) を選択
  4. リクエスト送信

f:id:yuu2634:20180228001357p:plain

うまく行けば画面下部に取得結果が出力されます。簡単ですね。


Instant Purge を実行する

Fastly の特徴でもある Instant Purge を実行してみます。方法は複数ありますが、今回は該当 URI に PURGE リクエストを送ることでパージします。

  1. Purging - Purging - individual_url を選択
  2. 対象 URI を入力
  3. リクエスト送信

f:id:yuu2634:20180228002810p:plain

正常に処理されたことがレスポンスから読み取れます。

このように、Fastly 提供の API を簡単な操作で呼び出すことが可能です。


まとめ

  • Postman + fastly-postman の組み合わせで利用できます
  • Globals には Fastly のアカウント情報を登録します
  • Environment には Fastly のサービス情報を登録します

Fastly API Documentation からも分かる通り、Fastly には豊富な API が揃っています。Postman と組み合わせることで、リクエストの組み立てや API の検証を効率化できます。