連携ガイド

このページでは、mutes エンドポイントをシステムに統合するにあたって把握しておくべき各種ツールと主要な概念について説明します。内容は次のセクションに分かれています。

• 便利なツール
• 主要な概念
• 認証
• 開発者ポータル、プロジェクト、アプリ
• レート制限
• fields と expansions

​

便利なツール

このエンドポイントの統合に役立つ主要な概念に入る前に、次の内容に慣れておくことをおすすめします。

​

Postman

Postman は、エンドポイントのテストに役立つ優れたツールです。各 Postman リクエストには、利用可能な内容をすばやく把握できるよう、すべてのパスおよびボディパラメータが含まれています。Postman コレクションの詳細は、“Using Postman”ページをご覧ください。 

​

コードサンプル

お好みのプログラミング言語でこのエンドポイントのセットアップを試したい方へ。出発点として使えるさまざまなコードサンプルをGitHub ページで公開しています。

​

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

コミュニティ提供のサードパーティ製ライブラリを活用して、スムーズに始めましょう。適切なバージョンタグを確認することで、v2 エンドポイントに対応したライブラリを見つけることができます。

​

重要な概念

​

認証

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

OAuth 1.0a ユーザーコンテキスト では、成功するリクエストを行うために API キーとユーザーのアクセス トークン一式を使用する必要があります。アクセス トークンは、あなたが代理でリクエストを行うユーザーに紐づいている必要があります。別のユーザーのアクセス トークン一式を生成したい場合は、そのユーザーが 3-legged OAuth フロー を使用してあなたのアプリを承認する必要があります。

なお、OAuth 1.0a は扱いが難しい場合があります。この認証方式に不慣れな方は、ライブラリ の利用、または Postman のようなツールの使用をおすすめします。

​

開発者ポータル、Project、開発者アプリ

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

​

レート制限

毎日、何千人もの開発者が X API にリクエストを送信しています。これらの大量のリクエストを適切に管理するため、各エンドポイントにはレート制限が設けられており、アプリまたは認証済みユーザーに代わって実行できるリクエスト数が制限されています。 

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

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

エンドポイント	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 リクエスト

​

fields と expansions

X API v2 の GET エンドポイントでは、fields と expansions と呼ばれる一連のツールを使って、API から返したいデータを正確に選択できます。expansions パラメータを使用すると、ペイロード内で参照されているオブジェクトを展開できます。たとえば、固定表示された List を取得する場合、次の expansions を取得できます:

• owner_id

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

X API v2 data dictionary に、fields と expansions を併用するためのガイドを追加しました。

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

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