Adrop Open APIを使用すると、コンソールに直接アクセスしなくても、キャンペーン成果やバックフィル収益などのレポートデータをAPIで直接照会できます。
APIを使用するには、まずコンソールでAPIキーを発行する必要があります。
基本情報
| 項目 | 値 |
|---|
| Base URL | https://lake.adrop.io |
| プロトコル | HTTPS |
| 認証方式 | API Key（x-api-keyヘッダー） |
APIキーの発行
コンソールでAPIキーを生成し、Open APIにアクセスできます。
キーの作成
APIキーメニューへ移動
コンソールの**[管理]** > **[APIキー]**メニューに移動します。
キー情報の入力
**[APIキーを発行する]**ボタンをクリックし、以下の情報を入力します。| 項目 | 説明 |
|---|
| キー名 | 用途を識別できる名前（例：「レポート連携」） |
| 権限範囲 | 1つ以上の選択が必須です。現在report:read権限をサポートしています。 |
キーのコピーと保管
生成されたAPIキーをコピーし、安全に保管します。APIキーは生成直後に1回だけ確認できます。以降は再表示できませんので、必ずコピーして安全な場所に保管してください。
権限範囲
APIキーに付与できる権限の一覧です。
| 権限 | 説明 |
|---|
report:read | キャンペーンレポートおよびバックフィル収益データの照会 |
すべてのAPIリクエストにx-api-keyヘッダーを含める必要があります。
curl -X POST https://lake.adrop.io/report \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{...}'
APIキーは外部に共有しないでください。キーが漏洩した場合は、直ちに廃棄して新しいキーを発行してください。
APIキーの管理
キー一覧の確認
コンソールの**[管理]** > **[APIキー]**メニューで、発行済みのAPIキー一覧を確認できます。
| 表示項目 | 説明 |
|---|
| キー名 | キー作成時に入力した名前 |
| APIキー | 一部マスキングされたキー値 |
| 権限範囲 | 付与された権限の一覧 |
| 作成日 | キーが作成された日付 |
キーの廃棄
使用しなくなったキーは**[廃棄]**ボタンで即座に廃棄できます。
廃棄されたAPIキーは即座に認証がブロックされます。そのキーを使用中のシステムでAPI呼び出しが失敗する可能性がありますので、廃棄前に連携中のサービスがないか確認してください。
関連ドキュメント
レポートAPI
キャンペーン成果およびバックフィル収益データをAPIで照会する方法
