Skip to main content

Getting API access and finding the API docs

API access and documentation

J
Written by James

MediStack offers an API for clinics, partners and pharmacies that need to integrate.

Creating your own API key

Clinics can generate their own API keys from the Developers section of the clinic portal. The pages there only appear for users who hold the "Manage API Keys" permission — a clinic admin can add it to a clinician record under Clinicians, then open the record, tick Manage API Keys and save. Log out and back in for the permission to take effect.

The API Documentation link in the Developers section lists every available operation and its fields. Check there before asking support for access — many integrations need nothing more than a key the clinic creates itself.

Requesting access

If your integration needs something the portal doesn't cover — a partner or pharmacy connection, for example — contact [email protected] describing your integration and the systems involved.

Common integration: creating leads from your own website form

A marketing or eligibility form on a clinic's own website can create leads in MediStack directly. The patient registration operation accepts a status of lead, along with name, email, mobile number, date of birth, address, indications, referral code and patient groups, so submissions land in the clinic's leads list just as a portal registration would. Post from your server rather than from browser code so the API key is not exposed publicly.

Did this answer your question?