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

manage follows エンドポイントのはじめ方

このクイックスタートガイドでは、Postman を使用して manage follows エンドポイントへ最初のリクエストを送信する手順を説明します。 各種言語のサンプルコードは、GitHub の X API v2 sample code リポジトリをご覧ください。

前提条件

このガイドを完了するには、リクエストを認証するための keys and tokens が必要です。以下の手順で keys and tokens を生成できます。
  • developer account に登録 し、承認を受ける。
  • 開発者ポータルで Project と関連付けられた developer App を作成する。
  • アプリの “Keys and tokens” ページに移動して必要なクレデンシャルを生成する。すべてのクレデンシャルは安全な場所に保存すること。

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

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

このエンドポイントにリクエストを送信する方法はいくつかあり、さまざまなツール、コード例、ライブラリが利用できますが、ここでは手順を簡素化するために Postman を使用します。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください。 Postman に X API v2 コレクションを読み込んだら、「Follows」フォルダに移動し、「Follow a user 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” という名前の environment を選択し、“initial value” と “current value” の fields にキーとトークンを追加します(environment のドロップダウン横の目のアイコンをクリック)。 正しく設定されていれば、これらの変数はリクエストの authorization タブに自動的に反映されます。  

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

Manage follows エンドポイントは 2 つの ID を受け取ります。1 つはソースユーザー(別のユーザーをフォローまたはフォロー解除したいユーザー)用、もう 1 つはターゲットユーザー(フォローまたはフォロー解除されるユーザー)用です。ソースユーザーの ID は、認証中のユーザーのユーザー ID と一致している必要があります。今回は、自分のユーザーに紐づく ID を指定できます。自分の ID は次の 2 つの方法で確認できます。
  1. user lookup by username エンドポイントを使用して、ユーザー名を渡すと id フィールドが返ってきます。
  2. アクセストークンの数値部分が自分のユーザー 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:リクエストを送信して、レスポンスを確認する 準備が整ったら、「Send」ボタンをクリックすると、次のレスポンスが返ってきます。
    "data": {
        "following": true,
        "pending_follow": false
    }
}
同様に、ユーザーのフォローを解除する場合は、同じ Postman コレクション内の「Unfollow a user ID」リクエストを使用します。ただし、unfollow エンドポイントでは、source_user_id と target_user_id の両方のパラメータをパス変数として渡す必要があります。