Home
Partner Platform
Everflow Essentials For Partners
Using Your Partner Platform API Key
Using Your Partner Platform API Key

Using Your Partner Platform API Key

How to find, use, and secure the Affiliate API key your network admin shared with you — plus a quick clarification on why our developer docs say 'Affiliate' while the UI says 'Partner'.

What this is

The Affiliate API is the same data and controls you see in Partner Platform — reporting, postbacks, offers, coupon codes, product feeds — available to your own scripts, dashboards, and tools. Once your network admin shares an API key with you, you can wire your data into anything that speaks HTTP.

What you can build with it

A few of the most common partner workflows we see:

Daily revenue digest in Google Sheets — a scheduled script pulls yesterday's conversions and updates a sheet your finance team already uses.Live Looker / Tableau / Power BI dashboard — one source of truth your whole team trusts, refreshed every 15 minutes from the API.Slack alerts on conversion drops — if today's conversion rate on your top offer falls below threshold, you find out before your account manager does.Bulk postback management — spinning up a new campaign with 40 sub-IDs? Create postbacks programmatically instead of clicking 40 times.Custom partner-side ingestion — pipe conversions into your own attribution model, fraud filter, or commission engine without re-keying anything.
📊
Partner Platform
Your data lives here
🔑 API key
📝
Google SheetsDaily revenue digest
📈
BI dashboardsLooker, Tableau, Power BI
📢
Slack alertsConversion-drop pings
🧰
Custom scriptsBulk postbacks, ingestion

The API key is the passport that lets your tools read and write the same data you see in Partner Platform. Below: how to find yours, how to use it, and what to watch out for.

Quick clarification: Partner = AffiliateWhy our developer docs say "Affiliate API" while the UI says "Partner Platform"

The Everflow UI uses Partner as the umbrella label — affiliates, publishers, influencers, agency partners all live in the same model. Our developer docs still call it the Affiliate API because the URL path is /v1/affiliates/ — kept that way for backward compatibility so existing integrations keep working. Same surface, two names. If you landed on this page after Googling "Everflow affiliate API," you're in the right place.

Do you have an API key yet?

Partners cannot create their own API keys. The brand or network you work with — they use the Everflow Core Platform — has to generate a key for you and share it. If you don't see the API tab in your account (covered below), reach out to your account manager and ask them to add one for you. Once they do, the tab appears with your key inside.

Treat your API key like a passwordDon't paste it in shared docs, Slack messages, or unencrypted email. Store it in a secrets manager or password vault. If you ever think it's been exposed, tell your account manager immediately so they can revoke it and issue a new one.

Where to find your API key

Once your account manager has issued a key, follow these steps to find it in Partner Platform.

1Open Company Settings → My AccountIn the left navigation rail, click Company Settings. A popover opens — click My Account at the top.

Company Settings popover with the My Account item highlighted

2Switch to the API tabYou land on the General tab by default. Click the API tab to switch over.

My Account General tab with the API tab highlighted

If you don't see the API tab here, your account manager hasn't issued a key yet. Reach out and ask.
3Copy your keyYour API key sits in the API key card. Use the copy icon on the right of the card to put it on your clipboard, then paste it somewhere secure.

API tab showing the API key field (key value redacted)

You can also restrict the key to specific IP addresses on the right — useful if you're calling the API from a fixed server.

Using your API key

Authentication header

Send your key in the X-Eflow-API-Key header on every request. Requests without the header (or with a misspelled header name) fail with a 401 No Authentication Method Found.

Base URL

The base URL for the Affiliate API is https://api.eflow.team/v1/affiliates. EU-hosted accounts use https://api-eu.eflow.team/v1/affiliates instead — check with your account manager if you aren't sure which one applies to you.

Example request

Pull a quick dashboard summary to confirm your key works:

Affiliate API — dashboard summary
# Pull a dashboard summary to confirm your key works
curl -H "X-Eflow-API-Key: YOUR_API_KEY" \
  https://api.eflow.team/v1/affiliates/dashboardsummary

What you can do with it

The Affiliate API covers everything you can see in Partner Platform, plus a few extras. The most-used surfaces, grouped by what you're trying to do:

Reporting

Pull aggregated reporting data with custom dimensions (offer, country, sub IDs, time of day) and metrics.Search conversions by date range, status, offer, or any sub parameter.Stream raw clicks for low-latency feeds into your own data warehouse.Look up on-hold conversions and individual click or conversion details by ID.Export aggregated data or conversion lists to CSV.

Offers & tracking

List runnable offers available to you, with payout and creative metadata.Generate tracking URLs and impression URLs programmatically — useful if you're managing thousands of placements.Retrieve deals, coupon codes, and product feeds for the offers you run.

Postbacks & account

Create, update, search, and delete partner postbacks programmatically.Pull your billing data and invoice history.List and inspect traffic-blocking and source-control settings.

Connected to multiple brands?

If you work with multiple brands through the Everflow Marketplace, there's a separate Marketplace API that gives you one umbrella view across all of them. It uses a different base path (/v1/partners/) and a different key. Setup walkthrough lives at Managing Your Marketplace API Keys.

Troubleshooting

I get a 401 "No Authentication Method Found"

The header is missing or misspelled. Make sure it's X-Eflow-API-Key (note the dashes), and that the value is your full key with no leading or trailing whitespace.

I get a 403 "Out of realm"

You're hitting an endpoint that doesn't belong to the Affiliate API. Affiliate keys only work against /v1/affiliates/ paths — they can't access /v1/networks/ (Network) or /v1/advertisers/ (Advertiser) endpoints. Switch to an Affiliate-API endpoint or ask your account manager whether you need a different key type.

I lost my API key

Your account manager can re-share the existing key — they don't need to issue a new one. Reach out and ask them to send it again from their side.

I think my key was exposed

Tell your account manager immediately. They can revoke the existing key and issue a new one. Treat an exposed API key the same way you'd treat an exposed password.

I'm hitting rate limits on heavy reporting pulls

Rate limits are network-wide, so resetting your key doesn't change anything. If you're running high-frequency reporting (e.g. polling every few minutes), ask your account manager about Firehose — a real-time event stream that's designed for this use case.

Technical reference

For the full list of endpoints, request/response shapes, and code examples in curl/Python/Node.js, head to our developer documentation. The Affiliate API overview is the right starting point — every endpoint group (reporting, offers, postbacks, etc.) links out from there.

More for production integrations

Rate limiting — request budgets and how to handle 429 responses gracefully.Paging — how to walk through large result sets without missing rows.Marketplace API — for partners connected to multiple brands through the Everflow Marketplace.How To Navigate Partner Platform — refresher on where everything lives in the UI.
Next in This Series