Getting started
Get to know the integration process and actions required to integrate with Docplanner.
Learn about both tech and business context of the integration.
# Intro
This guide is meant to explain in details full business context of the integration with Docplanner API. It focuses on explaining both the process of the integration with all key milestones, as well as most important parts of the development - definition of all the API objects and walkthrough the crucial flows.
The fastest way to use our API is installing our client libraries currently there are 2 of the available:
If you want to create the integration from scratch, apart from reading this guide, check out our API Documentation (opens new window).
Currently, Docplanner API is designed only to be utilized by providers of the medical software - it provides access only to limited set of resources authorized by the customers.
# API Type
In Docplanner we're using RESTful API. You you want to find out more about this technology - click here (opens new window)
In accordance to RESTful guidelines, we use standard HTTP methods. Each has a special meaning:
| Verb | Description |
|---|---|
| GET | Retrieve resources |
| POST | Creates resources or execute custom actions |
| PUT | Replace resources |
| PATCH | Partial update of resources |
| DELETE | Delete resources |