メインコンテンツへスキップ

API Key と Secret

API Key と Secret (Consumer Key と Secret とも呼ばれます) は、X API にアクセスするために必要となる最も基本的な認証情報です。これらの認証情報は X App のユーザー名とパスワードのような役割を果たし、どの App からのリクエストかを X API が識別するために使用されます。 これらの認証情報は、認証エンドポイント によって、ユーザーアクセストークンとシークレットベアラートークン などの追加の認証情報を生成するために使用できます。また、OAuth 1.0a のユーザーコンテキスト認証を必要とするリクエストを承認する際には、アクセストークンやその他の認可用パラメータと併せて、これらの認証情報を使用する必要があります。 

API Key と Secret の取得方法

X API Key と Secret を取得するには、次の手順に従ってください。
  1. X 開発者アカウントに登録する
  2. 開発者コンソール内で X App を作成します。X API v2 を使用したい場合は、開発者 App のキーとトークンを使用する必要があることに注意してください。  
X App を作成すると、API Key と Secret に加えて、ベアラートークンが表示されます。これらの認証情報は一度しか表示されないため、パスワードマネージャーなどの安全な場所に必ず保存してください。 キーやトークンの取り扱いについては、認証情報が漏えいした場合に取るべき対応も含めて、認証に関するベストプラクティスのページで詳しく説明しています。  

App 作成後に API Key と Secret を見つけて再生成する方法

すでに App を作成済みで、API Key と Secret を確認または再生成する必要がある場合は、次の手順に従ってください。
  1. 開発者コンソールにアクセスします
  2. サイドナビで「Apps」ドロップダウンを展開します
  3. 対象の API Key と Secret が関連付けられている App を開きます
  4. 「Keys and tokens」タブを開きます
ここで、その App に関連付けられているすべての認証情報を確認できます。   

API Key と Secret の使用方法

X Developer Platform をこれから探索している段階であれば、まずはプラットフォーム上でどのような機能が利用できるかを確認するために、ツールやライブラリの利用をおすすめします。これらのツールは認証処理を適切に扱ってくれるため、多くの時間と手間を節約できます。特に、開発初心者の方には Postman の始め方Insomnia の利用を推奨します。  リクエストを一から自分で構築したい場合は、OAuth 1.0a リクエストの認可 に関するガイドを参照してください。