WhatsApp Business API Postmanコレクション
PostmanはAPIのテストと開発に役立つ人気のツールです。Facebookは、WhatsApp Business APIの統合に取り組む開発者の便宜を図るため、API呼び出がフルセットで入っているPostmanコレクションを開発しました。
このドキュメントでは、WhatsApp Business API Postmanコレクションを設定し、それを使用してWhatsApp Business APIのリクエストを作成する方法を示します。
開始する前に
以下が必要です。
- WhatsApp Business API Postmanコレクション
- GitHubリポジトリのクローンを作成するか、GitHubリポジトリを.zipファイルとしてダウンロードします。
ステップ1: WhatsApp Business API Postmanコレクションを設定する
Postmanを起動したら、[インポート]をクリックして、GitHubから取得したPostmanコレクションパッケージ内の2つのJSONファイルを選択します。インポートが完了すると、[コレクション]の下にWhatsApp Business APIのリストが表示され、右上隅の[環境]ドロップダウンメニューでWABiz Developerが選択可能になります。
ステップ2: WABizビジネス環境を構成する
Postmanは、構成可能な環境(実質的にはキー/値のペア)を提供します。これにより、よく使用される変数を作成し、それを複数のリクエストで参照できるようにすることができます。詳しくは、環境の管理に関するPostmanのドキュメントをご覧ください。
事前構成済みのWABiz Developer環境には、コレクションによって参照される部分的な変数のセットが含まれています。これらの変数の一部を、自分が使用する値に更新する必要があります。
環境変数を編集するには、[環境]ドロップダウンメニューの横にある小さな目のボタンをクリックし、次に[編集]をクリックします。
もっと簡単に環境変数を更新したい場合は、API応答で返される値を解析して対応する環境変数を更新するポストリクエストスクリプトを作成する方法もあります。これについては、Postmanブログの応答と連鎖リクエストからデータを抽出する方法に関する記事をご覧ください。
Webappホスト名
更新する必要がある変数の中で最も重要なのは、Webappアプリを表すURLです。すべてのリクエストはこの変数を{{URL}}として参照するので、この変数を正しいWebappホスト名に設定する必要があります。
認証トークン
コレクションからAPIを呼び出すには、認証トークンを取得して、環境変数を有効な値に置き換える必要があります。loginエンドポイントは認証トークンを生成し、応答として返します。返された認証トークンを取得し、その値で適切な環境変数を更新して、その後のAPI呼び出しで認証に使用できるようにします。
ステップ3: SSL証明書認証設定をオフにする
WhatsApp Business APIでは、HTTPSを使用する必要があります。Postmanはこのことを認識しており、SSL証明書のハンドシェイクを試みます。これを回避するには、非セキュア化されたHTTPSを使用します。
[Postman] > [設定] > [一般]タブに移動して、[SSL証明書認証]設定をオフにします。
注:この処理は、AppleがオペレーティングシステムレベルでSSL証明書を管理する方法に関係しているため、MacOS Catalina (10.15)でテストする場合は特に重要です。
ステップ4: 初回ログイン
API呼び出しを初めて送信する場合は、ログインして管理者パスワードを変更する必要があります。AdminUsernameおよびAdminPassword環境変数を初期設定値のadminおよびsecretに更新し、NewAdminPassword環境変数を自分で選択した値に更新します。
[認証]を[基本認証]に設定し、ユーザー名/パスワードの変数を以下のように指定します。[本文]タブで、new_passwordの値を変数NewAdminPasswordから入力する必要があります。[送信]をクリックしてリクエストを送信し、認証トークンの応答を取得します。
正常に応答を取得できたら、tokenの値をAdminAuthToken環境変数にコピーし、先ほど設定した新しいパスワードと一致するようにAdminPassword環境変数を変更します。[更新]をクリックして値を保存します。
これで、管理タスクを実行するための認証トークンを用意できました。Postmanコレクションはヘッダー内の変数を使用するので、毎回変数を再入力する必要はありません。
Login-Admin API呼び出しテンプレートの[本文]タブから、new_passwordプロパティを削除します。
ステップ5: 登録
登録プロセスの詳細については、登録ドキュメントをご覧ください。
[WhatsApp Business API]コレクションで、[02-Registration] > [Request-Code]を選択します。
API呼び出しを行う前に、[本文]タブの環境リストで、以下の重要な登録変数が正しく設定されていることを確認してください。
RegistrationRequestCountryCodeRegistrationRequestPhoneNumberRegistrationRequestMethodRegistrationRequestVNameCert- Base64証明書の文字列。FacebookビジネスマネージャのWhatsAppアカウントから取得します。TwoStepPIN- 二段階認証が有効になっている場合。
コピーするBase64証明書の値にキャリッジリターンまたは末尾のホワイトスペースが含まれていないことを確認します。この値は、末尾にスペースがない長い文字列でなければなりません。
Request-Code API呼び出しが成功すると、選択した方法でコードが取得されます。受け取ったコードでRegistrationRegisterCode環境変数を更新します。コレクションリストで[02-Registration] > [Register-Account]を選択し、API呼び出しを行います。呼び出しが201 Createdで成功すると、電話番号が登録され、連絡先の確認とメッセージの送信のためのインスタンスを使用する準備が整います。
ステップ6: テスト用のAPI呼び出しを送信する
これで、コレクション内の任意のAPI呼び出しを選択して起動できます。ログインAPI呼び出しから始めて、認証トークンがすべてのAPI呼び出しで使用できる最新のものであることを確認します。
API呼び出しは好みの方法で自由に編集できます。編集によって、WhatsApp Business APIとその応答をより簡単にテストできるようにしてください。
