For the complete documentation index, see llms.txt. This page is also available as Markdown.

Authentication

The impact.com REST API authenticates requests using HTTP Basic authentication. Each API access token consists of two values:

Credential
Purpose
Equivalent

Account SID

Uniquely identifies your token. Used as the HTTP Basic username.

Similar to a public API key

Auth Token

The secret credential. Used as the HTTP Basic password.

Similar to a secret API key

Send the pair Base64-encoded in the Authorization header:

Authorization: Basic base64(AccountSID:AuthToken)

All API requests must be made over HTTPS (port 443). Calls made over plain HTTP will fail. Requests with missing or incorrect credentials return a 401 status code.

All API requests are scoped to your account type:

As a Brand, your API base path is:

https://api.impact.com/Advertisers/{AccountSID}/...

Create an API access token

Mint your credentials in impact.com [User profile] → Settings → Technical → APICreate Access Token.

For the full UI walkthrough — including scope toggles, API version pinning, rotations, duplication, disables, deletes, and legacy migration — see Create an API Key.

New to impact.com? Start with a token that has read-only scopes so scripts can't accidentally mutate production objects. Promote to separate tokens per environment (dev / staging / prod) with narrowly tailored scopes when you're ready to ship.

Store credentials securely

Never hardcode secrets in repositories. Store them in a secrets vault or in encrypted environment variables — never in source control or shared chats.

Make an authenticated request

The examples below call the Campaigns endpoint with a GET request as a smoke test.

Interpret the response

  • 2xx — success.

  • 401 — bad or missing SID/Auth Token pair.

  • 403 — credentials authenticated, but the persona path or token scopes block the resource. Double-check Advertisers / MediaPartners / Agencies and the token's scope toggles.

  • 429 — slow down. Add exponential backoff with jitter in scripts and agents.

Protect your keys

Anyone with your Auth Token can make API calls on your behalf, up to the scopes granted. Follow these practices:

  • Use scoped tokens instead of full-access tokens — grant only the permissions the integration actually needs.

  • Create separate tokens for each integration, service, or environment (dev / staging / prod) so you can revoke one without affecting others.

  • Store credentials in a secrets vault or encrypted environment variables. Never commit them to source code, configuration files, or version control.

  • Reset tokens when team members leave or change roles.

  • Disable unused tokens rather than leaving them active — you can re-enable them later if needed.

  • Don't share credentials over email, chat, or other unencrypted channels.

Coming soon

OAuth 2.0 Authorization Code + PKCE flows for apps operating on behalf of many customers. Documentation will publish alongside developer onboarding once available.

Last updated