Integration process
To simplify the development of the integration, install our client libraries.
Remember that only integrations with all the flows implemented will be accepted and exposed in the production environment.
Getting sandbox access
The integration process starts with three simple steps:
- Obtaining sandbox access
- Installing your client library
- Making test API calls
To begin development, you’ll need credentials for the sandbox environment. Request them by filling out the form available here.
Use sandbox credentials
Always use your sandbox API keys for testing and development to avoid affecting live customer data.
Sandbox access includes a sample API client along with test clinic and doctor profiles. You can explore and interact with them by logging into the service.
After setting up your basic data, a Docplanner specialist will guide you through a kick-off meeting to help organize your project plan. Schedule this meeting by contacting integrations@docplanner.com.
Next, proceed with installing your client library. Detailed instructions are available here.
Acceptance tests
After completing development, contact a specialist to verify integration quality. We will arrange a joint session via your preferred communication platform.
During this session, a Docplanner specialist will guide you through our testing protocol. Details about the process can be reviewed here.
Acceptance criteria
Only integrations with all required methods implemented will be approved to ensure customer satisfaction.
The minimum set of required implemented flows includes:
- Mapping for all resources
- Synchronizing all bookings
- Real-time updates of doctors’ schedules
Activating integration for clients
The activation process can be customized to your workflow. Depending on whether authorization is configured through our app, we can either:
- Provide credentials directly to the client upon request
- Deliver credentials to you after client approval
The steps to obtain credentials depend on the chosen scenario:
Activation directly with customer
If activation is handled directly with the client, the clinic should contact their Customer Success specialist.
Activation on the software provider side
If you want to manage the integration and obtain credentials yourself, you must first receive approval from the clinic. Request credentials by emailing integrations@docplanner.com and including the client representative in CC.
Activation process overview
To ensure smooth initial synchronization, the activation process should include:
- (For PUSH communication method) Provide a configured endpoint URL to receive callbacks (see Callbacks section)
- Populate the doctor profile with mapped objects (services, insurances) as described in the mapping process
- Fill doctor calendars with available slots
- Synchronize all bookings in both directions (Docplanner ↔ partner system)
- Send calendar breaks and other availability-impacting objects to Docplanner
Blackbox tests
To maintain the highest quality standards, we conduct regular blackbox tests both manually and automatically. Our specialists may contact you to arrange joint sessions verifying the proper functioning of all system flows.
Additionally, our monitoring system continuously checks all endpoints used in the PUSH integration model. Pings are sent every 5 minutes, and any response other than a 5XX server error counts as confirmation of functionality. If 3 consecutive pings fail, an alert is triggered and sent to the email provided during the kick-off meeting.