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

​
ミュート管理エンドポイントのはじめ方

このクイックスタートガイドでは、Postman を使ってミュート管理エンドポイントへの最初のリクエストを送信する方法を説明します。 複数の言語でのサンプルコードをご覧になりたい場合は、GitHub の X API v2 sample code リポジトリをご参照ください。
前提条件このガイドを完了するには、リクエストを認証するための keys and tokens が必要です。以下の手順に従って keys と tokens を生成できます。
  • developer account にサインアップ し、承認を受けてください。
  • 開発者ポータルで Project と関連付けられた developer App を作成します。
  • アプリの「Keys and tokens」ページに移動して、必要な認証情報を生成します。すべての認証情報は安全な場所に保管してください。

​
ミュート管理リクエストを構築する手順

​
ステップ1：ツールまたはライブラリから始める

このエンドポイントにリクエストする方法はいくつかありますが、ここでは手順を簡単にするために Postman を使用します。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください。
Postman に X API v2 コレクションを読み込んだら、「Mutes」フォルダーに移動し、「ユーザーの id をミュート」を選択します。  

​
ステップ2：リクエストを認証する

X API に正しくリクエストを送信するには、権限があることを証明する必要があります。このエンドポイントでは、OAuth 1.0a ユーザーコンテキスト または OAuth 2.0 認可コード（PKCE 対応） のいずれかでリクエストを認証する必要があります。 この例では、OAuth 1.0a ユーザーコンテキストを使用します。 API Key、API Secret Key、OAuth 1.0a user Access Token、OAuth 1.0a user Access Token Secret などのキーとトークンを Postman に追加します。Postman 右上の “X API v2” 環境を選択し、環境ドロップダウン横の目のアイコンをクリックして表示される “initial value” と “current value” の fields にキーとトークンを入力してください。 正しく設定されていれば、これらの変数はリクエストの Authorization タブに自動的に反映されます。  

​
手順3：誰が誰をミュートするかを指定する

Manage mutes エンドポイントには2つのIDが必要です。1つはユーザー（他のユーザーをミュートまたはミュート解除したいユーザー）用、もう1つは対象ユーザー（ミュートまたはミュート解除されるユーザー）用です。ユーザーのIDは認証ユーザーのIDと一致している必要があり、つまりリクエストを認証する際には、そのユーザーIDに紐づく Access Tokens を渡す必要があります。この場合は、自分自身のユーザーの ID を指定できます。自分の ID は次の2つの方法で確認できます。
  1. user lookup by username エンドポイントを使用して、ユーザー名を渡すと id フィールドが返ってきます。 
  2. Access Token を確認すると、数値部分が自分のユーザー ID であることがわかります。  
target ID には任意の有効なユーザー ID を指定できます。Postman では「Params」タブに移動し、id パス変数の「Value」列に自分の ID を入力します。続いて「Body」タブに移動し、ミュートしたいユーザーの ID を target_user_id パラメータの値として入力します。いずれの ID の前後にもスペースを入れないでください。
KeyValue
id認証済みユーザーの ID
target_user_idミュートしたいユーザーの ID

​
ステップ4：リクエストを送信し、レスポンスを確認する

すべての準備が整ったら、「Send」ボタンを押します。すると、次の例に示すものと同様のレスポンスが返ってきます。 
      { "data": { "muting": true } }
“muting”: true を受け取った場合は、その id が target_user_id を正常にミュートしていることを示します 同じユーザーのミュートを解除するには、Postman に読み込まれた X API v2 コレクションの「Mutes」フォルダー内にある「Unmute a user ID」というリクエストを使用します。source_user_id には自分のユーザー ID を、target_user_id にはミュート解除する相手のユーザー ID を指定してください。これは JSON ボディとして送る必要はないため、source_user_id と target_user_id の必須クエリパラメータを追加していることを確認してください。 ミュート解除が成功すると、次の例と同様のレスポンスが返されます: 
      { "data": { "muting": false } }