Summary
A partner is an organisation that connects to Flow on your behalf, such as a corporate wellness scheme, a referral service or a fitness equipment provider. In Flow you set up each partner once, then give it its own API key and choose which membership types it can use.
✅ Each partner has its own API key, so you can see and control which partner is using Flow, and turn one off without affecting the others
✅ You choose exactly which membership types each partner can see and give to customers
✅ Memberships a partner gives out are recorded against that partner
| Time required | 5 minutes |
| User role | Administrator |
| Module | System Configuration > Partners |
Before You Start
| Prerequisite | Details |
|---|---|
| ✅ Partners turned on | OpenPlay turns on the Partners module for you. Contact OpenPlay Support to request it. |
| ✅ Partner permissions | Your role needs the Partner permissions below. They are all unticked by default. |
Partner permissions
To set them, go to System Configuration > Security, click Edit next to the role, then open Partners. Each Manage permission sits under the View permission it needs.
| Permission | Lets staff |
|---|---|
| View Partners | See the Partners page and each partner's details |
| Manage Partners | Create partners and change their name and status |
| View Partner API keys | See a partner's API keys |
| Manage Partner API keys | Issue, edit and revoke a partner's API keys |
| View Partner membership types | See which membership types a partner can use |
| Manage Partner membership types | Add and remove a partner's membership types |
Staff only see the tabs their role allows. To set an IP allowlist on a partner's API key, staff also need Update API Key IP Allowlist.
Step-by-Step Guide
1. Open Partners
- From the Home Page, go to System Configuration.
- Select Partners. The list shows each partner's name, type and status.
2. Create a partner
- Click Create Partner.
- Name: Enter the partner's name, as your team will recognise it.
- Status: Leave as Active.
- Click Create Partner.
3. Check the partner's details
Click the Edit (pencil) icon next to the partner. The partner page has three tabs:
- Details: the partner's name, type and status
- API keys: the keys the partner uses to connect. See How to issue and manage a partner's API key.
- Membership types: the membership types the partner can use. See How to choose which membership types a partner can use.
Type is set by OpenPlay and can't be changed. All partners are currently Generic.
4. Change a partner's name or status
- On the Details tab, click Edit basic settings.
- Change the Name, or set Status to Inactive.
- Click Save changes, or Undo changes to go back.
Important: Setting a partner to Inactive doesn't stop its API keys working. To stop a partner connecting to Flow, revoke its API keys. See How to issue and manage a partner's API key.