X APIを設定する

Xキャンペーンを行う前に必須の設定です。

Xキャンペーンを実施するには、XAPI連携設定が必ず必要です。

 

X API設定とは


BoosterでXキャンペーンを開催する際は、X Developer Platform(開発者プラットフォーム)

  • Basicプラン以上への加入
  • X API用のプロジェクトおよびAppの登録

を行う必要があります。

 

ここでは

  • X Developer Platform(開発者プラットフォーム)の申請・登録
  • Basicプラン加入方法
  • X API用のプロジェクトおよびAppの設定方法
  • BoosterとX API(X)の連携方法

について説明します。

 

1.X Developer Platform(開発者プラットフォーム)の申請・登録


(1)連携させたいXアカウントにログインする

Boosterと連携させたいXアカウントで、 ログインします。

複数アカウントでログインしている場合は、連携させたいアカウント以外はログアウトしてください。

(連携させたいアカウント1つのみにログインする)

 

(2)X Developer Platform(開発者プラットフォーム)にアクセス

連携させたいXアカウントにログインした状態で、X Developer Platform(開発者プラットフォーム)にアクセスします。

画面右上のログインを選択し、再度連携させたいXアカウントでログインします。

Notion image
 

ログイン後、右上にXアカウントアイコンが表示されたのを確認したら、隣の開発者ポータルを選択します。

Notion image
 

2.Basicプランに加入する


(1)加入するプランを選ぶ

画面左側の「Basic」を選択し、「Start Monthly Access for Only $200 USD/month」の月額プランに加入します。Get Started Nowを選択し、次の画面に進みます。

Notion image
 

(2)規約を確認し、同意する

XのデータおよびAPIの使用例について、テキストボックス内に説明文を入力します。

※説明文の内容は、こちらを参考にして入力してください。

規約同意のチェックボックスにすべてチェックし、Submitを選択します。

Notion image
 

(3)決済情報を入力し、Basicプランの加入を完了する

X API Basicプラン利用料の支払い情報を入力します(クレジットカード決済のみ)。

必要事項を入力し、Add card & Subscribeを選択して決済します。

※基本的にはキャプチャ赤枠部分のみの入力で問題ありません。

Notion image
 

決済が完了すると、以下のような表示になります。これでBasicプランへの加入は完了です。

Notion image
 

3.X API用のプロジェクトおよびAppの設定方法


(1)プロジェクトを作成する

デフォルトのプロジェクトが既に作成されているため、これを編集してキャンペーン用プロジェクトの設定を行います。

 

左サイドメニューより、Projects & Appsを開き、「デフォルトプロジェクト」を選択します。

その後、プロジェクト名下部のSettingsを選択し、さらにEditを選択します。

Notion image
 
  • Project name
  • Project use

を入力・選択してSaveでプロジェクトの設定を確定します。

応募者には表示されないため、管理しやすいブランド/サービス名等を入力しておけば問題ありません。

 

これでプロジェクトの設定は完了です。

 

(2)Appを作成する

プロジェクトの作成が完了したら、Appを作成します。Appはプロジェクトと同様、デフォルトのAppが既に作成されているため、これを編集してキャンペーン用Appの設定を行います。

 

左サイドメニューProjects & Apps内、(1)で作成したプロジェクトの下にある「サンプルApp」を選択します。

 

App detailsのEditより、App編集画面を表示します。

  • App name
  • App icon
  • Description
  • Environment

を入力・アップロードします。「Environment」は「Production」を選択しましょう。

最後にSaveを選択して、Appの設定を確定します。

Notion image
 

(3)X認証設定を行う


Appの作成が完了したら、X認証設定を行います。

 

①User authentication settings

Set upを選択します。

Notion image
 

以下を参考にフォームの内容を入力してください。

項目
必須/任意
回答内容
App permissions
必須
Read
Type of App
必須
Web App, Automated App or Bot
App info Callback URI / Redirect URL
必須
https://booster.me/accounts/auth/twitter/callback/
App info Website URL
必須
対象サービスのウェブサイトURLを入力してください
App info Organization name
任意
主催者の会社名を入力してください
App info Organization URL
任意
主催者の会社ホームページを入力してください
Terms of service
任意
対象サービスの利用規約を入力してください
Privacy policy
任意
対象サービス又は主催者のプライバシーポリシーを入力してください
 

入力が完了したら、Saveを選択して内容を保存します。

保存後に以下の画面が表示されますので、

  • Client ID
  • Client Secret

をそれぞれコピーして、大切に保管してください。

特に、Client Secretはこの画面以外で再表示ができないためご注意ください。これらはBoosterとXAPI連携を完了する際に必要になりますので、必ずメモしておきましょう。

※万一、Client Secretを忘れたり紛失した場合はRegenerateより再生成が可能です。再生成をした場合は、BoosterのX API連携設定も最新の値で保存しなおしてください。

Notion image
 
 

4.BoosterとX API(X)を連携する


X Developer Platform(開発者プラットフォーム)で取得した情報をもとに、BoosterのX API連携設定を行います。

 

(1)連携させたいXアカウントにログインする

Boosterと連携させたいXアカウントで、 ログインします。

複数アカウントでログインしている場合は、連携させたいアカウント以外はログアウトしてください。

(連携させたいアカウント1つのみにログインする)

(2)Xアプリケーション名を設定する

Boosterダッシュボード内、「ブランド設定」より連携設定を開きます。X API設定を選択し、Xアプリケーション名を入力します。

応募者に表示される名称のため、サービス名などわかりやすい名称を入力するとよいでしょう。

Notion image
 

(3)API X認証を行う

次に、認証作業に進みます。X認証して設定するを選択してください。

API v2用 X認証

認証するXアカウントにご注意ください

キャンペーンを開催するXアカウントでX認証を行ってください。

複数アカウントでログインしている場合は、連携させたいアカウント以外はログアウトしてからX認証を実行してください。

 
Notion image
 

各X認証の説明は以下の通りです。

  • API v2用 X認証
    • Xキャンペーンポストの予約投稿などで、ポスト系機能の使用や画像や動画などのメディアを添付するために必要な認証です。

 

(4)OAuth2.0認証を行う

3-(3) X認証設定を行うで作成したXアプリケーションに応募者がXログインできるようにする設定・認証です。

保存してあるClient IDとClient Secretを入力し、X認証して設定するを選択してください。

認証するXアカウントにご注意ください

キャンペーンを開催するXアカウントでX認証を行ってください。

複数アカウントでログインしている場合は、連携させたいアカウント以外はログアウトしてからX認証を実行してください。

 
Notion image
 
  • Xアプリケーション名
  • API v2用 X認証
  • OAuth2.0

の入力および認証がすべて完了すると、下記のようにすべてのステータスバッジが「有効」の表示になります。

 

この状態になればX API連携設定は完了です。

Notion image
 

(5)APIの状態をチェックする

最後に、APIが正しく連携状態にあるかをチェックしましょう。

APIの状態をチェックするを選択し、「APIの状態を更新しました。」のポップアップが表示されたら連携状態は最新に保たれています。

Notion image
Notion image
 
🗒️

ヒント

「不明なエラーが発生しました。」の表示が出る場合は、XAPI設定が不十分またはXAPIのバージョン更新が行われている場合があります。この場合、XAPI設定を一度すべて削除し再連携をお試しください。

疑問は解決しましたか?
😞
😐
🤩