Skip to content

Postmanとサンプルリクエスト

Brazeでは、Postmanコレクションを通じて、すべてのエンドポイントに対してサンプルAPIリクエストを生成できます。このリファレンス記事では、Braze Postmanコレクションについて、コレクションとは何か、コレクションのセットアップと使用方法、リクエストの編集と送信方法について説明します。

Postmanとは

Postmanは、APIリクエストの構築とテストのための無料のビジュアル編集ツールです。他の方法（たとえばcURLを使う方法）と比べて、PostmanではAPIリクエストを編集したり、ヘッダー情報を確認したりすることができます。コレクション（事前に作成されたAPIリクエストのサンプルライブラリ）を保存できます。REST APIのセットアップを高速化するために、すべてのエンドポイントについてあらかじめ作成されたサンプル集を提供しています。

PostmanドキュメントのRun in Postmanをクリックして、Postmanコレクションを表示またはダウンロードして始めましょう。

Braze Postmanコレクションを使用する

Postmanアカウント（MacOS版、Windows版、Linux版をPostmanのWebサイトからダウンロードできます）をお持ちであれば、オレンジ色のRun in Postmanボタンをクリックすることで、ご自身のPostmanアプリでPostmanドキュメントを開くことができます。その後、環境を作成するか、Braze REST API環境をテンプレートとして使用し、利用可能なPOSTおよびGETリクエストをご自身のニーズに合わせて編集できます。

Postman環境をセットアップする

Braze Postmanコレクションは、テンプレート変数{{instance_url}}を使用してBrazeインスタンスのREST API URLを事前に作成されたリクエストに置き換え、{{api_key}}変数をAPIキーに置き換えます。コレクション内のすべてのリクエストを手動で編集する代わりに、Postman環境でこの変数を設定できます。ドロップダウンからテンプレート環境（Braze REST API Environment Template）を選択して変数値をご自身のものに置き換えるか、独自の環境をセットアップすることもできます。

独自の環境をセットアップするには、以下の手順を実行します。

  1. WorkspacesタブでEnvironmentsを選択します。
  2. ＋プラスボタンをクリックして新しい環境を作成します。
  3. この環境に名前を付け（たとえば「Braze API Requests」）、instance_urlとapi_keyのキーを追加し、BrazeインスタンスとBraze REST APIキーに対応する値を指定します。
  4. Saveをクリックします。

PostmanのBraze REST API環境にAPIキーとインスタンスURLの変数を追加する。

コレクションからビルド済みのリクエストを使用する

環境を構成した後、コレクション内のビルド済みリクエストのいずれかを、新しいAPIリクエストを構築するためのテンプレートとして使用できます。ビルド済みリクエストの使用を開始するには、PostmanのCollectionsメニュー内でそのリクエストをクリックしてください。これにより、Postmanアプリのメインウィンドウで新しいタブとしてリクエストが開きます。

一般に、Braze APIエンドポイントが受け付けるリクエストには、GETとPOSTの2種類があります。エンドポイントが使用するHTTPメソッドに応じて、ビルド済みリクエストを異なる方法で編集する必要があります。

POSTリクエストを編集する

POSTリクエストを編集する場合、リクエストを開き、リクエストエディターのBodyセクションに移動します。読みやすくするために、JSONリクエストボディをフォーマットするrawラジオボタンを選択します。

PostmanでPOST User Trackリクエストを編集する際のBodyタブ

GETリクエストを編集する

GETリクエストを編集する場合は、リクエストURLで渡されるパラメーターを編集します。そのためには、Paramsタブを選択し、表示されるフィールドのキーと値のペアを編集します。

PostmanでGET配信停止済みメールアドレスのクエリリスト取得リクエストを編集する際のParamsタブ。

リクエストを送信する

APIリクエストの準備ができたら、Sendをクリックします。リクエストが送信され、レスポンスデータがリクエストエディターの下のセクションに表示されます。ここから、Braze APIから返された生データの確認、HTTPレスポンスコードの確認、リクエストの処理にかかった時間の確認、ヘッダー情報の確認ができます。

ステータスが201 Created、応答時間が269ミリ秒のPOSTリクエストからの本文レスポンスデータの例。
New Stuff!