連携ガイド

このページでは、mutes の endpoint をシステムに統合する際に把握しておくべき、いくつかのツールと重要な概念について説明します。ページは次のセクションに分かれています。

• 役立つツール
• 重要な概念
• 認証
• developer portal、Project、App
• レートリミット
• fields と expansions

​

便利なツール

この endpoint を統合する際に役立つ重要な概念に入る前に、次の内容に慣れておくことをおすすめします。

​

Postman

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

​

コードサンプル

お好みのプログラミング言語でこの endpoint をセットアップするためのコードをお探しですか？出発点として利用できる各種コードサンプルを、GitHub ページで公開しています。

​

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

コミュニティが提供するサードパーティ製ライブラリを活用して、導入を始めましょう。適切なバージョンタグを確認すれば、v2 の endpoint に対応したライブラリを見つけられます。

​

重要な概念

​

認証

すべての X API v2 の endpoint では、リクエストを認証するために「キーおよびトークン」と呼ばれる一連のクレデンシャルが必要です。この endpoint へのリクエスト認証には、OAuth 1.0a ユーザーコンテキストを使用できます。 

OAuth 1.0a ユーザーコンテキストを使用するということは、リクエストを成功させるために API Key とユーザーの Access Tokens のセットを使用する必要があることを意味します。access token は、あなたが代理してリクエストを行うユーザーに関連付けられている必要があります。別のユーザーの Access Tokens のセットを生成する場合は、そのユーザーが 3-legged OAuth フローを使用してあなたの App を承認する必要があります。

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

​

developer portal、Project、開発者用 App

X API v2 の endpoint で利用できる認証情報一式を取得するには、デベロッパーアカウントに登録し、そのアカウント内にProjectを作成し、さらにその Project 内に開発者用 Appを作成する必要があります。作成後は、開発者用 App 内でキーおよびトークンを確認できます。  

​

レートリミット

毎日、何千人もの開発者が X API にリクエストを送信しています。これらの膨大なリクエストを管理するため、各 endpoint にはレートリミットが設定されており、App または認証済みユーザーに代わって行えるリクエスト数が制限されています。 

これらの endpoint はユーザーレベルでレート制限されており、代理でリクエストを送信する認証済みユーザーは、どの開発者用 App を利用する場合でも、その endpoint を呼び出せる回数に上限があります。 

以下の表は、各 endpoint のレートリミットを示します。

Endpoint	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 endpoint では、fields と expansions と呼ばれる一連のツールを使って、API から返すdataを正確に指定できます。expansions パラメータを使用すると、ペイロード内で参照されているオブジェクトを展開できます。たとえば、固定済みの List を取得する場合、次のexpansionsを指定できます:

• owner_id

fields パラメータを使用すると、受け取りたい各種データオブジェクト内のfieldsを細かく指定できます。この endpoint は主にユーザーオブジェクトを返します。デフォルトでは、List オブジェクトは id と name フィールドを返します。list.created_at や list.description といった追加フィールドを受け取るには、fields パラメータで明示的にリクエストする必要があります。 

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

以下の表は、lookup endpoint で利用可能なフィールドとexpansionsを示しています:

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