Getting started
The path from partner application to live referrals, and which integration option fits your team.
From application to live referrals
1. Apply for partner access
Apply in the Partner Portal. Rehabify reviews your organisation. Once it's approved, you get sandbox access, which includes test API keys and a sandbox webhook endpoint.
2. Create a sandbox API key
In the Partner Portal, go to Developers → API keys and create a key. Sandbox keys start with sk_test_. The full key is shown once, so store it in your secret manager straight away. See Authentication.
3. Build and test against the sandbox
Follow the Quickstart. Then use the magic phone numbers and the sandbox endpoints to rehearse every status and webhook event. In sandbox, no real patient is ever contacted.
4. Request production access
In the Partner Portal, choose Request production access and complete the go-live checklist. Our Go-live checklist lists what we look for.
5. Go live
Once Rehabify approves production access, create a sk_live_ key, set your live webhook endpoint and secret, and switch your configuration. Live keys can't be created before approval.
Choose your integration
| If you want to… | Use | Start with |
|---|---|---|
| Refer patients from your own product or EHR | REST API | Create a referral |
| Refer patients without any engineering work | No-code referral links | No-code referral links guide |
| Keep your records in sync automatically | Webhooks | Webhooks overview |
| Let patients start a chat with Joy from SMS, email or a QR code | WhatsApp deep links | WhatsApp deep links |
| Follow treatment progress | Sessions and progress reports | Sessions and Progress reports |
| See what you've earned | Commercial terms and commissions | Commercial terms & commissions |
Anatomy of a request
Every API call goes to https://api.physioaroundme.com/v1 over HTTPS and carries your secret key:
POST /v1/partners/referrals HTTP/1.1
Host: api.physioaroundme.com
Authorization: Bearer sk_test_xxx
Content-Type: application/json
Idempotency-Key: 9b2f6c1e-4d7a-4c3b-8e5f-2a1d0c9b8e7fEvery response tells you which environment handled the request and gives you an ID to quote to support:
HTTP/1.1 201 Created
Content-Type: application/json
X-Request-Id: req_5f2c9a1b7d3e4f60a1b2c3d4
X-Rehabify-Environment: sandbox
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1791883801Conventions covers pagination, idempotency, rate limits, timestamps and money. Errors covers every error code.