このクイックスタートガイドでは、Postman を使用して認証ユーザー照会エンドポイントへ初めてのリクエストを送信する方法を説明します。
各種言語のサンプルコードを確認したい場合は、X API v2 sample code の GitHub リポジトリをご覧ください。
前提条件
このガイドを完了するには、リクエストを認証するためのキーとトークン一式が必要です。これらのキーとトークンは、次の手順で生成できます。
- 開発者アカウントに登録し、承認を受ける。
- 開発者ポータルでプロジェクトを作成し、関連付けられた開発者アプリを作成する。
- アプリの「Keys and tokens」ページに移動して、必要な認証情報を生成する。すべての認証情報は安全な場所に保存してください。
このエンドポイントにリクエストする際に利用できるツール、コード例、ライブラリはいくつかありますが、ここでは手順を簡単にするため Postman を使用します。
X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください。
Postman に X API v2 のコレクションを読み込んだら、「Authenticated User Lookup」フォルダに移動し、「Lookup an Authenticated User」を選択します。
X API に正しくリクエストするには、自分に権限があることを確認する必要があります。このエンドポイントでは、OAuth 1.0a ユーザーコンテキスト または OAuth 2.0 認可コード(PKCE 対応) のいずれかでリクエストを認証する必要があります。
この例では、OAuth 1.0a ユーザーコンテキストを使用します。
API Key、API Secret Key、OAuth 1.0a user Access Token、OAuth 1.0a user Access Token Secret を Postman に追加する必要があります。Postman 右上の “X API v2” という environment を選択し、“initial value” および “current value” の fields にキーとトークンを追加します(environment のドロップダウン横の目のアイコンをクリック)。
正しく設定できていれば、これらの変数はリクエストの authorization タブに自動的に反映されます。
ステップ3:取得したいユーザー fields を決める
ステップ3の後に「Send」ボタンをクリックすると、レスポンスにはデフォルトの user object の fields(id、name、username)が含まれます。
id、name、username 以外の追加の fields を受け取りたい場合は、リクエストで field および/または expansion パラメータを指定してください。
この演習では、異なるオブジェクトから次の3つの追加 fields セットをリクエストします。
-
プライマリユーザーオブジェクトにおける追加の user.created_at フィールド。
-
返されるユーザーに関連付けられた固定済み Post オブジェクトのデフォルト fields:id と text。
-
関連する Post オブジェクトにおける追加の tweet.created_at フィールド。
Postman で「Params」タブに移動し、「Query Params」テーブルに次のキー:値のペアを追加します。
| | |
|---|
| Key | Value | Returned fields |
| user.fields | created_at | user.created_at |
| expansions | pinned_tweet_id | includes.tweets.id, includes.tweets.text |
| tweet.fields | created_at, author_id | includes.tweets.created_at, includes_tweets.author_id |
これで「Send」ボタンの横に同様の URL が表示されるはずです。
https://api.x.com/2/users/me?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=author_id,created_at