X APIを設定する

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

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

 

X API設定とは


BoosterでXキャンペーンを開催する際は、X Developer Console サイト(開発者サイト)

  • X API用のAppの作成・設定
  • X API クレジットの事前購入

を行う必要があります。

 

ここでは

  • X Developer Console サイト(開発者サイト)の申請・登録
  • X API用のAppの設定方法
  • X API クレジットの事前購入方法
  • BoosterとX API(X)の連携方法

について説明します。

 
 

X Developer Console サイト(開発者サイト)の申請・登録


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

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

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

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

 

(2)X Developer Console サイト(開発者サイト)にアクセス

連携させたいXアカウントにログインした状態で、X Developer Console サイト(開発者サイト)にアクセスします。

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

Notion image

ログイン後のDeveloper Console画面

Notion image
 

X API用のAppの設定方法


(1)X API用のAppを作成する

画面左側のアプリをクリック。

Notion image
 

画面右上の + をクリック。

Notion image
 

「アプリケーション名」の入力と「Enviroment」の選択を行います。

「Environment」は「Production」を選択しましょう。

⚠️

「アプリケーション名」は応募者側にも見える箇所のため、応募者向けにわかりやすい名称に設定しましょう。

Notion image
 

(2)X認証設定を行う

アプリの作成が完了したら、該当アプリの をクリック。

Notion image
 

右下のセットアップをクリックし、各項目の設定を行います。

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 infoWebsite URL
必須
対象サービスのウェブサイトURLを入力してください
App infoOrganization name
任意
主催者の会社名を入力してください
App infoOrganization URL
任意
主催者の会社ホームページを入力してください
Terms of service
任意
対象サービスの利用規約を入力してください
Privacy policy
任意
対象サービス又は主催者のプライバシーポリシーを入力してください
Notion image

入力が完了したら、変更を保存するをクリックし内容を保存します。

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

  • Client ID
  • Client Secret

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

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

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

Notion image
 

X API クレジットの事前購入


(1)X API クレジットを購入する

⚠️

X APIの新料金体系では、利用状況(APIリクエスト数や取得データ量等)に応じて費用が変動するため、事前に正確な費用を算出することが難しくなっております。 下記費用単価は、当社にて確認できている情報をもとにした参考価格となります。実際のご利用料金とは異なる場合がございますので、あらかじめご了承ください。

ダッシュボード画面のクレジットを購入するをクリック。

Notion image
Notion image
 

応募想定数と開催日数から想定される費用分を事前に購入

💡

費用単価につきましては、下記をご参考ください。

Notion image
 

<X API費用項目及び費用単価>

費用項目
金額
応募チェック費用(一人当たり)
$0.025
レポート作成費用(一日当たり)
$0.015

例)- 応募数3,000名、開催期間 7日間の場合

費用項目
金額
応募チェック費用
$75
レポート作成費用
$0.105
 

購入が完了したら、実際にBoosterへの連携に移ります👇

 

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


X Developer Console サイト(開発者サイト)で取得した情報をもとに、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設定を一度すべて削除し再連携をお試しください。

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