Getting Started
Understand the integration process and the necessary steps to connect with Docplanner.
Gain insights into both the technical details and business context of the integration.
Introduction
This guide offers a complete overview of the Docplanner API integration, addressing both technical and business perspectives. It walks you through the full integration process, highlights key milestones, and explains core development components — including detailed definitions of API objects and step-by-step workflows.
The fastest way to get started is by using one of our client libraries. Currently, we provide two options:
If you prefer to build your integration from scratch, we recommend following this guide alongside our comprehensive API Documentation.
Note: The Docplanner API is exclusively available to medical software providers. Access is limited to a specific set of resources authorized individually by each customer.
API Architecture
Docplanner exposes a RESTful API that follows established REST principles.
The API uses standard HTTP methods with clearly defined purposes:
| Method | Description |
|---|---|
| GET | Retrieve existing resources |
| POST | Create new resources or trigger custom actions |
| PUT | Replace entire existing resources |
| PATCH | Apply partial updates to resources |
| DELETE | Remove resources |