メインコンテンツへスキップ
このガイドでは、初めてリクエストを送信するための手順を順を追って説明します。X アカウントに登録した直後に役立つリソースです。 コードサンプル、より技術的なガイド、または Postman のようなグラフィカルツールを利用したい場合は、初回リクエストにあたって次のガイドをご検討ください。 このガイドでは、API Key と Secret、ユーザーの Access Token と Secret、App Access Token を取得し、安全な場所に保管していることを前提とします。これらの取得方法は、X API へのアクセスを取得する ガイドの手順に従って学べます。

​
ステップ 1. 使用したい endpoint を特定する

X API は、X のウェブサイトやモバイルアプリで行える操作の多くを、コードを使って実行できるようにします。 API で利用可能な endpoint の一覧は API Reference Index に掲載していますが、シンプルさのため、まずは次のいずれかを利用することをおすすめします。

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

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

​
Postman

Postman は、REST endpoint にリクエストを送信するために使用できるビジュアルツールです。X API で利用可能なさまざまな endpoint を使い始めたり探索したりするのに役立つ、Postman に関する資料を用意しています。 最初のリクエストの実行方法やキーおよびトークンの追加方法を学ぶために、“Getting started with Postman” チュートリアルをお読みになることをおすすめします。 また、X API v2 の各 endpoint 向けに、ほとんどが Postman を使用したクイックスタート ガイドも作成しています。これらのガイドは各 endpoint セクションにありますが、以下に一部を示します。
  • クイックスタート ガイド: Tweet を投稿する
  • クイックスタート ガイド: Posts を検索する
  • クイックスタート ガイド: ユーザーをルックアップする
なお、Postman では streaming endpoint にリクエストを送信できません。Filtered stream または 1% sampled stream のクイックスタート ガイドをご覧になり、これらの endpoint の扱い方をご確認ください。 よりシンプルなグラフィカルツールをご希望の場合は、Insomnia の使用もご検討ください。

​
サンプルコード

リクエストを行うために簡単なコードを使いたい場合、各 X API v2 の endpoint ごとに複数の言語でサンプルコードを用意しています。 コードサンプルは GitHub リポジトリ X-API-v2-sample-code で参照できます。ここには、リクエストが正しく動作するように認証情報の設定方法を説明した README ファイルも含まれています。 たとえば、ユーザー照会用 endpoint の cURL 例を以下に示します。このリクエストを使用するには、ACCESS_TOKEN と USERNAME をそれぞれ App Access Token と X のハンドルに置き換えてください。あとは、このコードをコマンドラインツールにコピー＆ペーストし、Enter（Return）キーを押します。 
curl "https://api.x.com/2/users/by/username/$USERNAME" -H "Authorization: Bearer $ACCESS_TOKEN"

​
ライブラリ

優れた X Developer コミュニティは、さまざまなプログラミング言語向けに、X API へのリクエストに利用できるライブラリも提供しています。 コミュニティ製ライブラリを掲載した「Tools and libraries」ページ（/x-api/tools-and-libraries/overview）を用意しています。各ライブラリには、リポジトリをローカル環境にセットアップし、最初のリクエストを実行する方法を学べる README が用意されているはずです。
ご注意: 問題が発生した場合は、リクエストを送る endpoint に関する開発者向けドキュメント、「Tools and libraries」ページ、サポートセクション、またはフォーラム上のコミュニティをご確認・ご利用ください。成功するリクエストの実行までサポートします。

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

リクエストが成功すると、そのリクエストに関連する metadata を含むペイロードが返されます。 GET の HTTP メソッドを利用する endpoint を使用した場合、リクエスト先のリソース（Post、ユーザー、List、Space など）に関する metadata が JSON 形式で返されます。返却された各 fields を確認し、要求した情報を X 上のコンテンツに対応付けられるか確認してください。 POST、PUT、または DELETE の HTTP メソッドを利用する endpoint を使用した場合、X 上でアクションを実行しています。X.com またはモバイル App を開き、そのアクションを確認できるか追跡してください。

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

各endpointには、リクエストを調整するために使用できるパラメータがそれぞれ異なります。たとえば、GET endpointを使用する際は、fields と expansions パラメータを指定して、追加のmetadataフィールドを取得できます。また、search Posts、Post counts、filtered stream といったendpointで提供される各種フィルタリング機能を活用し、取得するdataを関心のあるPostsのみに絞り込むことができます。 利用中のendpointのAPI Referenceには、リクエストパラメータおよびfieldsの全一覧が掲載されており、統合に役立つ情報は統合ガイドや基礎解説ページにも多数掲載されています。 ご利用いただける各種学習資料の詳細は、Important resources ガイドをご覧ください。
⌘I