メインコンテンツへスキップ

ピン留めされた List エンドポイントグループのはじめ方

このクイックガイドでは、Postman を使ってピン留めされた List エンドポイントへ最初のリクエストを送る方法を説明します。 各種言語のサンプルコードを確認したい場合は、X API v2 sample code の GitHub リポジトリをご覧ください。

前提条件

このガイドを完了するには、リクエストを認証するためのキーとトークンが必要です。以下の手順でキーとトークンを生成できます。
  • 開発者アカウントに登録し、承認を受ける。
  • 開発者ポータルで Project と、その Project に関連付けた 開発者アプリ を作成する。
  • アプリの「Keys and tokens」ページに移動し、必要な認証情報を生成する。生成した認証情報はすべて安全な場所に保存すること。
X API v2 の Postman コレクションを読み込む ワークスペースに X API v2 の Postman コレクションを読み込むには、次のボタンをクリックしてください。  

リクエストの認証

lookup エンドポイントに正常にリクエストするには、OAuth 1.0a ユーザーコンテキストOAuth 2.0 App-Only、または OAuth 2.0 認可コード(PKCE 対応) のいずれかを使用できます。ただし、manage エンドポイントでは、OAuth 1.0a ユーザーコンテキストまたは OAuth 2.0 認可コード(PKCE 対応)でのみ認証できます。 いずれの場合でも、Postman を使用している場合は、環境を適切に設定していれば、デフォルトの認証キーとトークンがリクエストに自動入力されます。 これを行うには、(Postman の右上にある)“X API v2” という名前の環境を選択し、環境のドロップダウン横の目のアイコンをクリックして “initial value” と “current value” の fields にキーとトークンを追加します。これらのキーには次が含まれます:
  • API Key(Consumer Key とも呼ばれます)
  • API Secret Key(Consumer Secret とも呼ばれます)
  • OAuth 1.0a user Access Token
  • OAuth 1.0a user Access Token Secret
  • OAuth 2.0 App Access Token
  • OAuth 2.0 Client Key(アプリの設定で OAuth 2.0 User Authentication 設定を行っている場合のみ利用可能)
  • OAuth 2.0 Client Secret(アプリの設定で OAuth 2.0 User Authentication 設定を行っている場合のみ利用可能)