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

manage follows endpoint の始め方

このクイックスタート ガイドでは、Postman を使用して manage follows endpoint に最初のリクエストを送信する方法を説明します。 各種言語のサンプルコードをご覧になりたい場合は、X API v2 サンプルコード の GitHub リポジトリをご参照ください。

前提条件

このガイドを完了するには、リクエストを認証するためのキーおよびトークン一式が必要です。これらのキーおよびトークンは、次の手順で生成できます。
  • デベロッパーアカウントに登録し、承認を受ける。
  • developer portal で Project と関連付けられた 開発者用 App を作成する。
  • App の「Keys and tokens」ページに移動し、必要なクレデンシャルを生成する。すべてのクレデンシャルは安全な場所に保存する。

フォロー管理リクエストを作成する手順

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

この endpoint にリクエストを送る方法として利用できるツール、コード例、ライブラリはいくつかありますが、ここでは手順を簡略化するために Postman を使用します。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください。 Postman に X API v2 コレクションを読み込んだら、「Follows」フォルダーに移動し、「Follow a user ID」を選択します。  

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

X API に正しくリクエストを送信するには、アクセス権があることを確認する必要があります。この endpoint を使用する場合は、OAuth 1.0a User Context または OAuth 2.0 Authorization Code with PKCE のいずれかでリクエストを認証してください。 この例では OAuth 1.0a User Context を使用します。 Postman にキーおよびトークン、具体的には API Key、API Secret Key、OAuth 1.0a ユーザー Access Token、OAuth 1.0a ユーザー Access Token Secret を追加する必要があります。これは、Postman 右上の “X API v2” という名前の environment を選択し、“initial value” および “current value” fields にキーおよびトークンを追加することで行えます(environment ドロップダウン横の目のアイコンをクリック)。 正しく設定されていれば、これらの変数はリクエストの authorization タブに自動的に反映されます。  

ステップ3: 誰が誰をフォローするかを指定する

Manage follows endpoint は2つのIDを受け取ります。1つはソースユーザー(他のユーザーをフォローまたはフォロー解除したいユーザー)用、もう1つはターゲットユーザー(フォローまたはフォロー解除されるユーザー)用です。ソースユーザーのIDは、認証しているユーザーのユーザーIDと一致している必要があります。この場合は、自分のユーザーに属するIDを指定できます。自分のIDは次の2つの方法で確認できます。
  1. user lookup by username endpoint を使用して、ユーザー名を渡すと id フィールドが返されます。 
  2. Access Token を確認すると、数値部分があなたのユーザーIDです。  
ターゲットIDは有効なユーザーIDであればどれでも構いません。例えば、@XDevelopers のユーザーIDは 2244994945 です。 Postman で「Params」タブに移動し、id パス変数の「Value」列にあなたのIDを入力します。次に「Body」タブに移動し、target_user_id パラメータの値として 2244994945(@XDevelopers のユーザーID)を入力します。いずれのIDの前後にもスペースを入れないでください。
KeyValue
id(あなたのユーザーID)
target_user_id2244994945
「Send」ボタンをクリックすると、関係のステータスを含むレスポンスオブジェクトが返されます。
  • “following”: true が返ってきた場合、id は target_user_id を正常にフォローしています。
  • “pending”: true が返ってきた場合、target_user_id は保護されており、あなたのフォローリクエストを承認する必要があります。

ステップ4: リクエストを送信し、レスポンスを確認する すべての設定が完了したら、「送信」ボタンをクリックすると、次のレスポンスが返ってきます。
    "data": {
        "following": true,
        "pending_follow": false
    }
}
同様に、ユーザーのフォローを解除する場合は、同じ Postman コレクション内の「Unfollow a user ID」リクエストを使用します。ただし、unfollow endpoint を使用する際は、source_user_id と target_user_id の両方のパラメータをパス変数として渡す必要があります。
I