Overview
The Inform Direct Integration API is a RESTful API that allows external systems, such as Practice Management Systems (PMS), to connect directly with Inform Direct. It is designed to help reduce manual data entry, streamline onboarding, and keep systems in sync with Inform Direct.
For full documented guidance please see: https://informdirect.portal.swaggerhub.com/informdirectapi/docs/overview
What the API can do
The API currently provides four main endpoints :
- Add a company
Add a new company to your Inform Direct account. - Remove a company
Remove a company that is no longer needed. - Get all companies
Retrieve a list of all companies linked to your account. - Get a particular company
Retrieve high-level information for one specific company.
Data returned
When retrieving company information, the API returns the following high-level details :
- Company number
- Company name
- Inform Direct public URL for the company
This public URL can be used to create direct links from another system into Inform Direct .
Typical use cases
You can use the API to :
- connect a PMS or other external system to Inform Direct
- automate adding companies to your account
- remove companies programmatically
- keep company lists synchronised across systems
- create direct links from another platform to an Inform Direct company record
Getting started
1. Create your sandbox API key
Start by generating a sandbox API key so you can test the API in a safe environment without affecting live data .
2. Authenticate and make test calls
Use your sandbox API key to authenticate and try the available API calls in the sandbox environment .
3. Request your production API key
Once testing is complete and you are ready to go live, request a production API key and complete the verification process. To do so email support@informdirect.co.uk.
4. Connect your external systems
After approval and verification, you can connect your live external platforms directly with Inform Direct .
Recommended implementation process
A practical rollout approach would be:
- Review the four available endpoints.
- Create and test in the sandbox first.
- Confirm which company data you need from the API.
- Build and test the integration in your external platform.
- Request production access.
- Move to live use once verification is complete .