Auphere Partner API · Getting started
/ v0.1
Overview
The Auphere Partner API lets your SaaS platform give every one of your clients their own WhatsApp agent and template campaigns — without handling WhatsApp credentials or building messaging infrastructure.
The Partner API is a plain HTTP API. Your backend calls api.auphere.com with a secret key and, for each of your clients, can:
- Provision a workspace — an isolated agent, cloned from your blueprint and personalised with values you send.
- Connect WhatsApp — link that client’s own WhatsApp Business number through Meta Embedded Signup.
- Manage administrators — decide which phone numbers may talk to the agent, and with what permissions.
- Send campaigns — approved WhatsApp templates with dynamic variables, to one recipient or to thousands.
Mental model
Every concept in your platform maps to one in Auphere. You never handle Auphere internals — you always speak in terms of your own identifiers.
| In your platform | In Auphere |
|---|---|
| Your platform (the partner) | A partner account with a secret API key (ak_live_…) |
| A client / business in your product | An isolated workspace, referenced only by your id (external_client_ref) |
| The client's WhatsApp | A WhatsApp Business Cloud API channel owned by that client |
| The client's AI agent | An agent cloned from your partner blueprint at provisioning time |
| Bulk reminders / notifications | A template broadcast to 1..N recipients |
Two scopes, two capabilities
Every endpoint requires one of two scopes, and your keys can carry either or both. They are separate on purpose: creating clients is an integration-time capability, while messaging their end customers has real-world reach.
| Scope | What it allows |
|---|---|
provision | Create clients, connect their WhatsApp, manage administrators, read onboarding status |
broadcasts | List a client's approved templates and send campaigns to their contacts |
Ask for one key per capability if you want a leaked integration key to be unable to message anyone.
Isolation by construction
You never send us a workspace id — there is no field for one. We resolve the workspace from the pair (your partner identity, your external_client_ref), and every query then runs under that workspace’s row-level security. A client cannot see another client’s data, and a partner cannot see another partner’s. Someone else’s reference simply returns 404: we do not reveal whether it exists.
Where to go next
- Quickstart — your first client, end to end, in four calls.
- Provisioning clients — the blueprint and its placeholders.
- API reference — every endpoint, field by field.