How to issue and manage a partner's API key

Summary

A partner connects to Flow with an API key. Each key belongs to one partner, so Flow knows which partner is making each request and only lets it use the membership types you have chosen for it.

✅ Issue a key and send it securely to the partner

✅ Set when the key expires, and which IP addresses can use it

✅ Change a key's expiry or IP addresses without the partner needing a new key

✅ Revoke a key straight away if it is no longer needed or may have been shared


Before You Start

Prerequisite Details
✅ A partner See Partners: overview and setup.
✅ Permissions View Partner API keys to see keys, and Manage Partner API keys to issue, edit and revoke them. Update API Key IP Allowlist to set IP addresses.
✅ The partner's IP addresses (recommended) Ask the partner which IP addresses their system connects from.

Step-by-Step Guide

1. Open the partner's API keys

  1. Go to System Configuration > Partners.
  2. Click the Edit (pencil) icon next to the partner, then open the API keys tab.

2. Issue a key

  1. Click Issue key.
  2. Reference: Enter a name to recognise the key by, for example "Live connection". Each key needs a different reference, of up to 100 characters.
  3. Expires (optional): Choose the date the key stops working. Leave it empty for a key that never expires.
  4. Allowed IP addresses (recommended): Enter the partner's IP addresses or CIDR ranges, one per line. Leave it empty to allow any address.
  5. Click Issue key.
Issue key: reference, expiry and allowed IP addresses

3. Copy the key and send it to the partner

Flow shows the key once. Click the copy button next to it, then click Done.

The new key, shown once to copy. This example key is not real

Important: You won't see the full key again. Send it to the partner securely, for example through a password manager or an encrypted message, never in a plain email. If it is lost, revoke it and issue a new one.

4. Check the partner's keys

The API keys tab lists each key with its Reference, when it was Created, when it Expires, its Rate limit and its Allowed IPs.

A partner's API keys

The rate limit controls how many requests a key can make a minute. OpenPlay sets it, and most keys use the default.

5. Change a key's expiry or IP addresses

  1. Click the Edit (pencil) icon next to the key.
  2. Change the Reference, Expires or Allowed IP addresses, then click Save changes.
Editing a key's expiry and allowed IP addresses

The key itself doesn't change, so the partner can keep using it.

6. Revoke a key

  1. Click the Revoke (bin) icon next to the key.
  2. Click Revoke key to confirm.
Revoke this API key? It stops working and you can't undo this

Important: The key stops working straight away, and this can't be undone. To replace a key without a break, issue the new key first, wait for the partner to switch to it, then revoke the old one.


Related articles

Was this article helpful?
0 out of 0 found this helpful