Postman を使い始める

このチュートリアルでは、Postman とは何か、そして短時間でセットアップする方法を説明します。

​

はじめに

Postman は、グラフィカルユーザーインターフェースから API にリクエストを送信できるデスクトップおよびウェブアプリケーションです。API の機能を試したり、アプリケーションの不具合を調査したりする際には、X API、X Ads API、そして Labs の各エンドポイントで Postman の利用を推奨します。 

現在利用可能な Postman コレクションは次の 2 つです:

X API v2 Collection

X Ads API Collection

​

前提条件

X の Postman コレクションを使い始める前に、選択した X 開発者プラットフォームのツールに必要なアクセス権と認証情報があることを確認してください。アクセス方法の詳細は「はじめに」ページをご覧ください。

開発者アカウントを取得し、アプリをセットアップし、認証用のキーとトークンを用意し、利用予定の特定の API にリクエストを送るための環境を正しく整えたら、以下の手順に従って開始できます。  

​

X の Postman コレクションのはじめ方

​

ステップ1：X の Postman コレクションをアカウントに追加する

Postman で使いたいエンドポイントを自分で一つひとつ作成することもできますが、当社ではその作業を代わりに行い、すぐに使える関連 API のコレクションを用意しています。前述の「Postman コレクション」セクションのいずれかのリンクをクリックするだけで、選択した API に対応するすべてのエンドポイントを含むコレクションがあなたの Postman アプリに追加されます。これらのコレクションは Postman API network からも利用できます。各エンドポイントには利用可能なパラメータ、レスポンス例、認証方式があらかじめ設定されているため、機能を試し始めるにはクレデンシャルとパラメータ値を追加するだけです。

この例では、X の API v2 コレクションを使用します。   

​

ステップ2：キーとトークンを環境変数として追加する

コレクションをお使いの Postman インスタンスに追加すると、自動的に「X API v2」という環境が追加されます。ここにキーとトークンを追加する必要があります。本ステップでは、開発者向けアプリ（アプリ）から取得したキーとトークンを「X API v2」環境に追加する手順を説明します。 

「X API v2」環境にキーとトークンを追加するには、Postman 右上の「manage environments」ボタンをクリックします。   

環境の一覧から「X API v2」をクリックします。 

次に、Apps ダッシュボードで生成した各種キーとトークンそれぞれに対応する変数をテーブルに追加します。以下はテーブルの例です。

VARIABLE	INITIAL VALUE	CURRENT VALUE
consumer_key	QAktM6W6DF6F7XXXXXX	QAktM6W6DF6F7XXXXXX
consumer_secret	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX
access_token	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX
token_secret	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX
bearer_token	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX

上記のテーブルで使用されているキーとトークンは架空のものであり、リクエストで使用しても動作しません。 

認証情報を変数として追加し、X API v2 環境が選択されていることを確認したら、X API v2 コレクションへのリクエスト送信の準備は完了です。各エンドポイントの認可タブは、この環境から変数を自動継承するよう設定されています。 

Postman でユーザーアクセス・トークンを使用する場合は、XXXX をスキップして追加の詳細をご確認ください。

​

手順3：エンドポイントを選択する 

次は、コレクションからエンドポイントを選び、リクエストの作成を開始します。右側のナビゲーションでエンドポイントを選択できます。表示は次のとおりです。

この例では、X API v2 > Post Lookup > Single Post エンドポイントを使用します。 

​

ステップ4：Params タブに値を追加する

次のステップでは、Params タブに移動します。説明付きの非アクティブなパラメータと、そのパラメータが何を行うか、リクエストで指定できる可能な値の一覧が表示されているはずです。

この例では、expansions と tweet.fields のクエリパラメータを有効化し、次の値を追加します。

Key	Value
tweet.fields	created_at,attachments
expansions	author_id

さらにクエリパラメータに加えて、必須の Path Variable である id も追加する必要があります。このエンドポイントは Post を返すため、値として有効な Post ID を指定します。

Post ID は、x.com に移動して Post をクリックし、URL を確認することで見つけられます。たとえば、次の URL の Post ID は 1228393702244134912 です。

https://x.com/XDevelopers/status/1228393702244134912

Params タブで、すべてのクエリパラメータをスクロールして「Path Variables」セクションを表示します。使用したい Post ID を、id キーの値として追加します。

このステップの入力がすべて正しければ、Params タブは次のように表示されます。

​

ステップ5：リクエストを送信し、レスポンスを確認する

リクエストの設定が整ったら、「Send」ボタンをクリックします。 

正しく設定できていれば、次のペイロードが返ってきます。

{
    "data": {
        "author_id": "2244994945",
        "text": "What did the developer write in their Valentine’s card?\n  \nwhile(true) {\n    I = Love(You);  \n}",
        "id": "1228393702244134912",
        "created_at": "2020-02-14T19:00:55.000Z"
    },
    "includes": {
        "users": [
            {
                "username": "XDevelopers",
                "name": "Developers",
                "id": "2244994945"
            }
        ]
    }
}

​

Postman を使用してユーザーアクセス・トークンを生成する：

​

OAuth 1.0a を使用してユーザーアクセス トークンを生成する

OAuth 1.0a フローのテストコレクションで用いられる3段階のプロセスを確認します。

​

OAuth 2.0 を使用してユーザーアクセストークンを生成する

Postman で OAuth 2.0 のユーザーアクセストークンを生成する場合は、X のAPI v2 Postman コレクションと併用するための OAuth 2.0 アクセストークンを生成できます。 

ワークスペース内のコレクションをクリックし、「Auth」タブに移動して、タイプを「OAuth 2.0」に選択します。続いて「Configure New Token」の見出しの下にある「Configuration Options」へ進みます。「Grant Type」を「Authorization Code (With PKCE)」に更新できます。

Callback URL を、アプリケーションに関連付けられているコールバック URL と一致するように更新してください。加えて、以下のパラメータも更新します:

• Auth URL -  https://x.com/i/oauth2/authorize
• Access Token URL -  https://api.x.com/2/oauth2/token
• Client ID - Dev Portal の OAuth 2.0 クライアント ID
• Client Secret - 機密クライアントを使用している場合
• Scope の更新 - 接続したいエンドポイントに対応するスコープ（例: “tweet.read users.read”）
• Callback URL（リダイレクト URL とも呼ばれます）。アプリの認証設定にあるものと一致している必要があります。
• State - state

準備ができたら「Get New Access Token」をクリックしてアクセストークンを生成します。「問題が発生しました」と表示されるダイアログが出た場合は、ログインするために戻るボタンを押す必要があることがあります。ダイアログで「Authorize app」と表示されている箇所をクリックして、アプリにアカウントへのアクセスを許可してください。

アプリを承認すると Postman に戻り、トークンを確認して「Use Token」ボタンを選択し、認可済みユーザーとしてリクエストの送信を開始できます。

これで Postman コレクションを使用する準備が整いました。

​

次のステップ

Postman の「Code」ボタンをクリックすると、先ほど作成したリクエストを Python、Node、Ruby などお好みの言語向けコードに変換でき、すぐに始められます。Postman には参考になる優れたドキュメントがあります。エンドポイントへの統合をより迅速に進めるためのGitHub 上のサンプルコードもご用意しています。