メインコンテンツへスキップ
このガイドでは、最初のリクエストを送るまでの手順を順に説明します。X アカウントの登録直後に役立つリソースです。 コードサンプル、より技術的なガイド、または Postman のような GUI ツールを使いたい場合は、最初のリクエストに向けて次のガイドもご参照ください。 このガイドでは、API key and secret、user Access Token and Secret、App Access Token を取得し、安全な場所に保管していることを前提としています。取得方法は、X API へのアクセスの取得 ガイドの手順をご確認ください。

​
ステップ 1. 使用したいエンドポイントを特定する

X API を使うと、X のウェブサイトやモバイルアプリで行えるさまざまな操作を、コードで実行できます。 API で利用可能なエンドポイントの一覧は API リファレンス索引に掲載していますが、まずはシンプルさを優先して次のいずれかを使用することをおすすめします:

​
ステップ 2. リクエスト作成に使うツールを選ぶ

簡単に作成できるリクエストもあれば、構築が難しいものもあります。そこで、優れた開発者コミュニティが、複雑さの一部を抽象化するためのツールを提供しています。 以下に、推奨ツールとその使用方法の概要を示します。

​
Postman

Postman は、REST エンドポイントにリクエストを送信できるビジュアルツールです。X API で利用可能な各種エンドポイントを始めやすく、探索しやすくするために、Postman に関する有用な資料を用意しています。 最初のリクエストを実行するにあたり、キーやトークンの追加方法を学べる「Getting started with Postman チュートリアル」をお読みいただくことをおすすめします。 また、X API v2 の各エンドポイント向けにクイックスタートガイドも用意しており、その多くで Postman を使用しています。各エンドポイントのセクションでご覧いただけますが、以下にいくつかリンクを示します。
  • クイックスタート: Post を投稿する
  • クイックスタート: Post を検索する
  • クイックスタート: ユーザーをルックアップする
なお、Postman ではストリーミングエンドポイントにリクエストを送信できません。filtered stream または 1% sampled stream のクイックスタートガイドで、それらのエンドポイントの扱い方をご確認ください。 よりシンプルなグラフィカルツールをお好みの場合は、Insomnia の使用もご検討ください。

​
サンプルコード

リクエストを簡単なコードで実行したい方のために、各 X API v2 エンドポイント向けに、複数の言語でサンプルコードを用意しています。 コードサンプルは GitHub リポジトリ X-API-v2-sample-code から入手できます。ここには、リクエストで正しく動作するよう認証情報を設定する方法を学べる README ファイルも含まれています。 例として、ユーザー照会エンドポイントの cURL の例を以下に示します。このリクエストを使用するには、ACCESS_TOKEN と USERNAME をApp アクセストークン と X のハンドルに置き換えてください。続いて、このコードをコマンドラインツールにコピーして貼り付け、Return または Enter を押してください。 
curl "https://api.x.com/2/users/by/username/$USERNAME" -H "Authorization: Bearer $ACCESS_TOKEN"

​
ライブラリ

X Developer コミュニティの皆さんは、さまざまなプログラミング言語で、X API へのリクエストに使えるライブラリも多数開発しています。 私たちは、把握しているコミュニティ製ライブラリを一覧した「ツールとライブラリ」ページを用意しています。各ライブラリには、多くの場合、リポジトリをローカル環境にセットアップし、最初のリクエストを送る方法を学べる README が含まれています。
注意: 問題が発生した場合は、リクエスト先のエンドポイントに関する開発者向けドキュメントやサポートセクションをご確認いただくか、フォーラムでコミュニティにお問い合わせください。成功するリクエストを実行できるようサポートします。

​
ステップ 3. レスポンスを確認する

リクエストが成功すると、そのリクエストに関連するメタデータを含むペイロードを受け取ります。 GET HTTP メソッドを使用するエンドポイントを呼び出した場合、リクエスト先のリソース（Post、ユーザー、List、Space など）に関連するメタデータを JSON 形式で受け取ります。返ってきた各 fields を確認し、要求した情報を X 上のコンテンツに対応づけられるか確認してください。 POST、PUT、または DELETE の HTTP メソッドを使用するエンドポイントを呼び出した場合は、X 上でアクションを実行したことになります。X.com またはモバイルアプリにアクセスし、そのアクションを特定できるか確認してください。

​
ステップ 4. パラメータを使用してリクエストを調整する

各エンドポイントには、リクエストを調整するために使用できる固有のパラメータが用意されています。たとえば、GET エンドポイントで fields および expansions パラメータを使用すると、追加のメタデータフィールドを取得できます。さらに、search Posts、Post counts、filtered stream などのエンドポイントでさまざまなフィルタリング手法を試し、受け取る data を関心のある Post のみに絞り込むこともできます。 利用中のエンドポイントの API Reference で、使用可能なリクエストパラメータおよび fields の全一覧を確認できます。あわせて、統合ガイドや基礎解説ページでは、実装に役立つ情報を多数提供しています。 提供している各種学習リソースの詳細は、Important resources ガイドをご覧ください。