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

ピン留め List の endpoint グループのはじめ方

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

前提条件

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

リクエストの認証

lookup endpoint に正常にリクエストするには、OAuth 1.0a ユーザーコンテキストOAuth 2.0 App-Only、または OAuth 2.0 Authorization Code(PKCE 付き) のいずれかを使用できます。ただし、manage endpoint では、OAuth 1.0a ユーザーコンテキストまたは OAuth 2.0 Authorization Code(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(App の設定で OAuth 2.0 User Authentication 設定を行っている場合のみ利用可能)
  • OAuth 2.0 Client Secret(App の設定で OAuth 2.0 User Authentication 設定を行っている場合のみ利用可能)
I