連携ガイド

このページでは、ピン留めされたリストのエンドポイントを統合するためのツールと主要な概念について説明します。

---

​

便利なツール

このエンドポイントを統合するうえで重要な概念を説明する前に、まず次のツールに慣れておくことをおすすめします。

​

Postman

Postman は、エンドポイントをテストするのに便利なツールです。各 Postman リクエストには、利用できる項目をすばやく把握できるよう、すべてのパスパラメーターとボディパラメーターが含まれています。Postman コレクションの詳細については、「Postman の使い方」ページをご覧ください。

​

コードサンプル

このエンドポイントをお好みのプログラミング言語でセットアップするためのコードが必要な場合は、GitHub ページで、出発点として使えるいくつかのコードサンプルを利用できます。

​

サードパーティライブラリ

コミュニティが提供している サードパーティライブラリ を活用して、導入をスムーズに進めましょう。v2 エンドポイント向けのライブラリは、対応するバージョンタグを目印に探すことができます。

---

​

基本概念

​

認証

すべての X API v2 エンドポイントでは、キーやトークンとも呼ばれる一連の認証情報を使用してリクエストに認証を行う必要があります。このエンドポイントへのリクエストの認証には、OAuth 1.0a User Context を使用できます。

OAuth 1.0a User Context を使用するということは、リクエストを正常に行うために、一連の API Key とユーザー Access Token を使用しなければならないことを意味します。Access Token は、リクエストを代理して送信する対象のユーザーに関連付けられている必要があります。別のユーザー向けに Access Token のセットを生成したい場合は、そのユーザーが 3-legged OAuth flow を使ってあなたの App を承認する必要があります。

OAuth 1.0a は扱いが難しいプロトコルである点に注意してください。この認証方式に慣れていない場合は、ライブラリ を使用するか、または Postman のようなツールを利用することをおすすめします。

​

開発者コンソール、Project、および開発者 App

X API v2 のエンドポイントで利用するための一連の認証情報を取得するには、まず開発者アカウントに登録し、そのアカウント内にProjectを作成し、その Project 内に開発者 Appを作成する必要があります。その後、開発者 App 内でキーとトークンを確認できます。

​

レート制限

毎日、何万もの開発者が X API にリクエストを送信しています。これらの膨大な数のリクエストを管理するために、各エンドポイントには レート制限 が設定されており、App または認証済みユーザーごとに行えるリクエスト数が制限されています。

これらのエンドポイントはユーザーレベルでレート制限されており、あなたが代理でリクエストを行う認証済みユーザーは、どの開発者向け App からであっても、そのエンドポイントを呼び出せる回数が一定数に制限されています。

以下の表は、各エンドポイントに対するレート制限を示しています。

エンドポイント	HTTP メソッド	レート制限
/2/users/:id/pinned_lists	POST	15 分あたり 50 回のリクエスト
/2/users/:id/pinned_lists/:list_id	DELETE	15 分あたり 50 回のリクエスト
/2/users/:id/pinned_lists	GET	15 分あたり 15 回のリクエスト

​

フィールドとexpansions

X API v2 の GET エンドポイントでは、fields と expansions と呼ばれる一連のツールを使用して、API から取得したいデータを正確に選択できます。expansions パラメータを使用すると、ペイロード内で参照されているオブジェクトを展開できます。たとえば、ピン留めされたリストをルックアップすると、次の expansions を取得できます。

• owner_id

fields パラメータを使用すると、受け取りたい各種データオブジェクト内のどのフィールドを返すかを正確に選択できます。このエンドポイントは主にユーザーオブジェクトを返します。デフォルトでは、リストオブジェクトは id と name フィールドを返します。list.created_at や list.description などの追加フィールドを受け取るには、fields パラメータを使ってそれらを明示的にリクエストする必要があります。

X API v2 データ辞書には、fields と expansions を組み合わせて使用するためのガイドを追加しました。

以下の表は、lookup エンドポイントで利用可能なフィールドと expansions を示しています。

Endpoint	Fields	Expansions
/2/users/:id/pinned_lists	list.fields, user.fields	owner_id