Skip to main content

Overview

The [Settings] > [Integrations] menu is where you configure all external Adrop integrations.
  • API Keys: used for Open API calls and for decrypting rewarded ad SSV callbacks
  • Reward Ad SSV: configure the server URL that receives reward-completion callbacks — see Reward Ad SSV
The Integrations menu is accessible only to project members with the owner role.

Generating an API Key

1

Open the Integrations menu

Go to [Settings] > [Integrations] in the console.
2

Enter key information

In the API Keys section, click [Create API Key] and fill in the following:
Each project can have up to 10 active API keys. If you have reached the limit, revoke a key you no longer use, then create a new one.
3

Copy and store the key

Copy the generated API key and store it securely.
The API key is shown only once at creation. It cannot be retrieved afterward, so make sure to copy and store it securely.

Available Scopes

The Open APIs currently available are the Report API, the Context Targeting API, and the Campaign Booking Webhook. To use the Context Targeting API, grant both context-targeting:read and context-targeting:write. To use the Campaign Booking Webhook, grant both campaign:read and campaign:subscribe. context-targeting:read, context-targeting:write, and campaign:subscribe aren’t selected by default when you create a key, so select them yourself.

Calling the Open API

Basic Information

Authentication

Include the x-api-key header in every API request.
Do not share your API key externally. If a key is exposed, revoke it immediately and generate a new one.

Managing API Keys

Viewing Keys

View issued API keys in the API Keys section of the Integrations menu.

Changing Scopes

You cannot change the scopes of an issued API key. Create a new key with the scopes you need, switch your integrations to the new key, and then revoke the old key.

Revoking Keys

Revoke unused keys from the row menu using [Revoke].
Revoked API keys are blocked immediately. API calls using the revoked key will fail. Verify that no active integrations are using the key before revoking.
API keys that are connected to a Rewarded Ad SSV cannot be revoked. Change the API key in the SSV or delete the SSV configuration, then try again.

Reward Ad SSV

Register the SSV callback URL that receives reward-completion events and decrypt the payload

Report API

Query campaign performance and backfill revenue data via API

Context Targeting API

Manage context targeting options and Context IDs from your server

Campaign Booking Webhook

Receive changes to booked campaigns and look them up