The section will answer all your questions about using and integrating CareCloud APIs.
What is the purpose of CareCloud APIs?
You can integrate the external applications with the CareCloud platform via the documented CareCloud APIs. The integration enables data exchange between the CareCloud platform and an integrated external application.
Through CareCloud APIs, you can integrate applications designed for CareCloud platform users (POS and EPOS systems, e-shops, kiosks, BI, accounting systems, and more) or external applications designed for customers, i.e., mobile applications, customer portals, and customer microsites.
The CareCloud APIs documentation describes the unique data resources, explains their use through examples and use cases, and answers basic questions in the FAQ section.
What API is the best to use?
There are two CareCloud APIs:
- Customer API
- Enterprise API
The best way to decide what API to use is to look at the following section.
What is an external application?
An external application is your identification for CareCloud APIs. It helps us to know which application uses REST API. Because as an integrator, you could integrate more applications to one installation of our CareCloud APIs.
You have to use external_application_id in multiple resources around CareCloud APIs. The External application is not a resource; you can find or create an ID for your application in CareCloud administration.
If you don't know how to find it, here is a guide to get, create or manage existing applications.
What authentication is used for Enterprise API?
CareCloud APIs use Bearer authentication if resources require it. You can find the complete guide in the Authentication section
How exactly does the PUT verb work in CareCloud REST APIs?
Just a friendly reminder, all our update methods use HTTP PUT. This HTTP verb updates the whole structure, so ensure you have all the necessary data to avoid losing any.
HTTP PUT doesn't support updating a single parameter. You need to send the whole data set. For more information, read this article.
How do I create a customer account?
In the CareCloud platform, each customer has a customer account, to which all data related to this customer are assigned. The customer account can be found and identified by any unique identifier (such as a customer's email or phone number) associated with that account.
You can create a customer account using the method [POST] /customers. We also created a use case describing the whole process.
How can I log in as a customer?
Customer login is not mandatory in CareCloud APIs for specific resources. If the customer wants to access their personal or purchase data, they must log in. How to do it is described in the following use case section.