Start with the quickstart. It confirms your Test API key and the current API version.
Using the Clinic app? Read Use Affinity for Providers.
Start an integration
- Make your first request.
- Build a headless integration.
- Create provider access.
- Receive signed webhook events.
Use the correct mode
Use Test mode during development. Test mode accepts only synthetic data and never contacts a real pharmacy.
Move to Live mode only after Affinity approves the platform, practice, provider, and required products.
Read Test mode and Live mode before you build a release process.
Find exact request fields
Use the API reference for every path, parameter, request body, and response schema. Affinity generates the reference from the current Pier contract.
Use the TypeScript SDK for typed requests without writing HTTP calls directly.