Integrate Your Production System

Use CareCloud platform REST API to integrate with a production system (BI, DWH, Booking, Accounting, Warehouse etc.)

Setup and integration

Here, you will find the complete developer's Guide to CareCloud platform REST API integration with your application. Please read and learn more about the integration process and make the first steps easier and simpler with Quickstart. You can learn how to use our REST API and create the first API calls. This guide enables easy authentication and safe calling with full respect to your data security. You find here the description of API parameters and versioning, URL structure, error codes, and HTTP verbs.

Enjoy the CareCloud platform REST API Guide!

Use Cases

Get inspired by the best practices

Make your work easier

Save time and money

Learn more →

Quickstart

Are you new here? Launch with Quickstart!

Learn how to use REST API

Your first API call

Learn more →

Authentication

Learn how to authenticate to REST API

How to get and use bearer token?

Use REST API safe and sound

Learn more →

API Tools

Download "API Collection" and start using Postman

Integrate with REST API SDK easily

Use the basic building blocks of the PHP client API

Learn more →

Webhooks

A quick guide on how to use webhooks

Receive notification about data changes and actions

Use webhooks in the Marketing Automation app

Learn more →

API tools set

You will find here the easy way how to start using CareCloud API. Just download the collection and import it into your Postman installation. In a matter of minutes, you can do API calls on your own. Moreover, you learn here how to use CareCloud API SDK, the convenient wrapper around CareCloud PHP Client, starting with installing the package, creating your API client, and accessing all the API endpoints from the client object.

Here, you will find the API client in PHP with a quick integration base to customize your implementation. Open API 3.0 documentation helps you generate your API client and provides the Open API tools set.

Postman Collection

Install your Postman or access it online

Download CareCloud API collection

See the first API calls easy guide

GitHub →

SDK in PHP

Easy integration

REST API SDK with full list of resources

Best practice implemented

GitHub →

PHP API client

Quick integration base

Customize your implementation

Access all API endpoints

GitHub →

Use cases

You will find here detailed descriptions of specific use cases for your needs. Get inspired by describing the best practices for integrating CareCloud platform REST API with your application and make your work easier. Using the related use cases will save you time and money!

Customer account operations

Customer sign-up

To successfully sign up for a customer, you have to collect all the customer information. That might require using other CareCloud API resources. This process must be done before creating a customer account by [POST] /customers.
We will show you how to use resource stores, customer sources or customer properties for the use case. To get all options for store_id, you should call [GET] /stores. You will get a response containing the list of stores and their unique IDs.
Use the values in the sign-up form to let the customer pick the correct one. Store it for later use of [POST] /customers.
Now, you need to know what kind of customer source will be set to the customer. The customer source identifies the place/system/business where your customer came from. In short, it is his origin.
For example, one customer source could be an e-shop (the customer was registered through an e-shop), and another could be brick-and-mortar, so you know he was registered in a store.
Every customer source record of the customer can have an external ID. The ID represents the identification of the customer in that system. Later, you can search customers by this ID to synchronize between systems.
You can call [GET]/customer-sources to get a list of customer sources. Pick the one that fits the source and add an ID to the customer creation request in the following steps.
The customer's properties could be set directly in [POST] /customers or afterward if necessary with endpoint [POST] /customers/{customer_id}/property-records. Lists of all properties are available at [GET] /customer-properties.
Use the method [POST] /customers to create a customer account. Set store_id as the registration branch of a customer account and customer_source_id as a source of the customer registration.
Repeat POST method calls if you need to set other resources to the customer account.

Customer credentials verification

The use case can apply to e-shop or production system integration, where you need access to all customer's data and request verification from the customer through the login screen.

We recommended customer verification following way:

Display a sign-in form to the customer.
1. You can display a choice of customer identifier. CareCloud API currently supports options for email and customer's card number.
2. Alternatively, you can let the customer fills in his identifier without choosing a type and afterward decide on your side(form processing) if he filled email or customer's card. You can use regular expressions to make a decision.
The customer fills in his credentials and sends the form.
The application validates inputs (email format, customer's card format, password format) and informs the customer with an appropriate message in case of invalid input.
If the customer enters all inputs correctly, the application will validate credentials against CareCloud API with the POST /customers/actions/verify-credentials call.
Suppose CareClould API verifies a customer as a response. In that case, you will get a customer ID from CareCloud API, which you can use for receiving other customer information like purchases, reservations, loyalty information, or customer data.
If verification is unsuccessful, you will be informed by an appropriate message from CareCloud API. Depending on the message, you can display your message to the customer in your application.
The essential information is this use case was designed only for verification, so it doesn't mean the customer was logged in to CareCloud. If you want to log in customer, you need to keep this information on your side.

Search customer and get customer personal data

The use case can apply to e-shop or production system integration, where you need access to data of multiple customers or search for a customer by his identifiers (email, phone number, or name).

We recommended searching customer’s data following way:

If you need to search for data from one or multiple customers, use the resource GET /customers. To find one or more customers, you need to know their email, phone number, first name, last name, or birthdate.
Add them into query parameters. The more parameters you fill in, the better and more exact the result will be. In this method, you can get multiple results if the parameter’s value is general, like “name=John”.
The response contains customer information, including ID, personal data, or consent, that you can process as needed.
If you want to search for one specific customer and expect only one result from searching, please use the action method GET /customers/actions/search-customers.
Use strict mode in query parameters. In this mode, you must know the first name, last name, birth date, and customer’s card number.
If CareCloud has this customer, you are going to get an ID.
To access the customer’s data, you need to do one extra CareCloud API call where you will add the customer ID from the previous call as a path parameter GET /customers/{customer_id}.
Every resource or method from previous points returns structures with the customer ID. This ID can be used for other resources as a path parameter to limit results tied to the customer. For example, customer vouchers GET /customers/{customer_id}/vouchers or customer card GET /customers/{customer_id}/cards or customer properties GET /customers/{customer_id}/property-records and other you can find in API reference guide: https://developers.crmcarecloud.com/#tag/Customers

Find a customer by production system identification

The use case is applied if you need to find a customer with external(other than CareCloud API) identification. More information is below:

To find a customer with an ID from your system, creating a customer with a customer source record containing that ID is crucial. You can do that at https://carecloud.readme.io/reference/postcustomer. See the customer source parameter.
You can also add a customer source to the existing customer. To do that, you can use https://carecloud.readme.io/reference/postsubcustomersource.
If you are sure that all the customers have identification from your system, you can find the customer source record with an external ID in the endpoint: https://carecloud.readme.io/reference/getcustomersourcerecords. Add an ID and identification of customer source from CareCloud API to request.
If the customer source record exists, you will receive a structure with the customer ID in the response.
You can use customer ID for the next API calls, for example, for customer’s data in endpoint https://carecloud.readme.io/reference/getcustomer or update of the customer in endpoint https://carecloud.readme.io/reference/putcustomer.

Synchronize customers between production systems and CareCloud

The use case describes synchronizing customer data between CareCloud and other systems.

Try to find the customer in CareCloud with a customer ID from your system(e-shop, POS, ERP, accounting systems, and others). You can find the customer source record with that ID in the endpoint https://carecloud.readme.io/reference/getcustomersourcerecords. Add an ID and identification of customer source from CareCloud API to request.
If the customer source record exists, you will receive a structure with the customer ID in the response. Now you can get existing customer information and synchronize it in your system https://carecloud.readme.io/reference/getcustomer. Or update an existing customer in CareCloud https://carecloud.readme.io/reference/putcustomer.
If the customer source does not exist, you must create that customer https://carecloud.readme.io/reference/postcustomer with appropriate identification and customer source.
This use case will work only if you synchronize an external identification from the start. Otherwise, duplications can occur.

Customer personal data update

Updating the customer is a critical process, and it is crucial to do it right so you keep all the customer's data. For an update, please follow this use case:

For an update, you need to know your customer first. That means you have to have his ID. The ID could be reached in multiple ways, which you can find in other use cases. Information on how to get all the customer data is available in use cases: Search customers and get customer personal data or Find a customer by production system identification. Customer ID is available after Customer credentials verification. But then make sure you get complete customer data with GET /customers/{customer_id} to be able to modify them in the update call.
Now you have everything you need and you can update the customer's data with endpoint PUT /customers/{customer_id}. This endpoint has to contain all the customer information. All parameters that won't be set in the request will be lost because of the principle of the HTTP PUT verb.
The successful update is represented by 204 HTTP code. In case of an error, the error message explains the issue.
If you need to update a customer’s properties, please use endpoint PUT /customers/{customer_id}/property-records/{property_record_id}. There you can modify existing properties

Assign a card to the existing customer

This use case describes the process of assigning free cards to the existing customer. In this case, the customer holds the card and knows the number of the card. It covers only cards that exist in the database already and are ready to be used.

Find the card that customers holds by the card number. To do that, search by query parameter `card_number` in GET /cards.
If you got a successful result, that means the card you are looking for exists in the database. The next step is to check the card's parameters to confirm it is free to use. You need to check the parameter `customer_id` (should have the value `null`) to make sure the card is not assigned to another customer.
Next step is to add a customer identification to the card. With the following API call from resource PUT /cards. Set the parameter `customer_id` with the customer id. Other parameters stay unchanged.
After the successful API call, the card has been assigned to the customer, and it's ready to be used. In case of any error, please follow the error message to find the solution.

Forgotten password

The use case can apply to e-shop or production system integration, where a customer needs to change his password in CareCloud.

We recommended changing the customer's password in the following way:

The customer can request a change if he doesn't remember his password.
The customer fills in the email address to the application form. The application validates the email address structure.
After the email address validation, the application checks its existence in CareCloud with an API call GET /customers. If the email address is present, the application sends an email with the link to change the password.
The customer opens an email and clicks on the link.
The customer is forwarded to the application form for password change.
The customer fills out the form with a new password, and the application validates the amount and type of the characters in the password(It must follow the CareCloud API restriction for the password PUT /customers/{customer_id}).
After successful validation, the application has to update a new password in the customer’s account. For that, the application has to do a CareCloud API call PUT /customers/{customer_id} with the new password.
If successful, the application shows a success message to the customer and forwards him to the login form.

Sending purchases

Send order/purchase

The use case describes when the POS, e-shop, or other system wants to send a paid purchase/order. All benefits and discounts were applied (or not), and the system needs to send the purchase/order to CareCloud. If this is the case you are dealing with, please follow:

Before the transaction, please ensure your system has synchronized products, product groups, and brands with CareCloud. Depending on your setup, synchronization could be necessary every time your products changes.
To send the purchase, please use the following endpoint [POST] /purchases/actions/send-purchase.
Ensure you set all necessary parameters; the values match current purchase values; lower the price depending on points or credit use and use all benefits returned from CareCloud API in previous steps (if used). Also, make sure to set the payment_type parameter appropriately depending on the type of transaction.
In case of success, the CareCloud API will return the purchase ID.

Cancel order/purchase

If you need to cancel a purchase already sent to CareCloud, please follow these steps:

For cancelation of an order or a purchase, please use the endpoint for sending purchase: [POST] /purchases/actions/send-purchase.
Almost all parameters have to be the same as in the original purchase. The only changes are in parameters `canceled`( `true` value if sending canceled purchase), `bill_id`(has to be a unique number), and `bill_number`(please use `bill_id` from the original purchase/order ).

Check out process

Application of benefits in the shopping cart

The use case can apply to an e-shop or POS where a customer wants to use his benefits (rewards, discounts, coupons, or vouchers). The use case describes only the part with the application of benefits. The other parts, such as sending the final purchase or identification of the customer, are part of checkout use cases, too.

For the proper application of benefits, please follow this:

The e-shop sends the current content of the customer's shopping cart and the unique voucher (if the customer added some) codes in the benefit_codes parameter through the end-point in [POST] /purchases/actions/accept-payment.
1. Please remember to set all the necessary parameters as payment_type and others depending on the API reference guide.
2. Different types of benefits could be applied depending on the chosen setup.
The CareCloud API returns all possible benefits, which you can apply to the customer's shopping cart, the number of loyalty points gained from the potential purchase, or the total amount of the customer's loyalty points after purchase. If the response doesn't contain any rewards or discounts, our algorithm found no benefit that could be applied to the customer.
The e-shop will keep all the information from the CareCloud API response.
If the customer changes the shopping cart's content, the e-shop must repeat the request to the endpoint [POST] /purchases/actions/accept-payment with updated shopping card data. The response to the call can be different this time because the customer might fulfill some of the defined conditions (amount of specific product or money threshold and others).

Loyalty points payment of e-shop order/POS bill

The use case is designed to allow you to use loyalty points for payments. The POS, e-shop, or another system can process point payments when a customer has available points in his account.

First, you need to know your customer. For that, you can find a customer by one of the identifiers (please check the use case Get customer personal data) or search him (please check the use case Search customers and get customer personal data).
After identifying the customer, you need to check his point credit and see if he can process a payment or has enough points to cover the purchase. The resource wallet provides the number of available points here: [GET] /wallet/actions/points-overview.
Depending on the number of points, POS can send the maximum amount of used points at the purchase with all purchase items in the endpoint [POST] /purchases/actions/accept-payment.
CareCloud API will respond with a list of recommended benefits and discounts and information about the number of points that can be used with that transaction.
The POS/e-shop will keep that information about the number of purchase points and lower the final purchase price. Both information will be used in the following request to endpoint [POST] /purchases/actions/send-purchase.
In the case where a customer wants to modify the shopping cart, you can change [POST] /purchases/actions/accept-payment request and repeat it multiple times before sending a final purchase [POST] /purchases/actions/send-purchase.

Credit payment of e-shop order/POS bill

The use case is designed to allow you to use credit payments. The POS, e-shop, or another system can process credit payments when a customer has available credits in his account.

First, you need to know your customer. For that, you can find a customer by one of the identifiers (please check the use case Get customer personal data) or search him (please check the use case Search customers and get customer personal data).
After identifying the customer, you need to check his credit and see if he can process credit payments or has enough credit to cover the purchase. The resource wallet provides the number of available credits here: [GET] /wallet/actions/credits-overview.
Depending on the available credit and the customer’s decision on how much credit he wants to use, POS can send the maximum amount of used credit at the purchase with all purchase items in the endpoint [POST] /purchases/actions/accept-payment. In case of credit payment, the appropriate payment_type has to be used ( type C; for more details, please see parameter `payment_type` in the documentation).
CareCloud API will respond with a list of recommended benefits and discounts and information about the credit that can be used with that transaction.
The POS/e-shop will keep that information about the used credit and lower the final purchase price. Both information will be used in the following request to endpoint [POST] /purchases/actions/send-purchase.
In the case where a customer wants to modify the shopping cart, you can change [POST] /purchases/actions/accept-payment request and repeat it multiple times before sending a final purchase [POST] /purchases/actions/send-purchase.

Synchronization of products, product groups, and product brands

This scenario should be used when you want to synchronize products from POS, e-shop, or other production system into CareCloud. This step should be recommended before you start applying rewards and discounts or sending purchases after checkout.

If you use product brands they should be synchronized with the endpoint POST /product-brands/batch. It allows you to add multiple product brands in one request. Please consider splitting the request if you have more than 1000 records to make sure the synchronization will be successful.
For product group synchronization CareCloud API provides endpoint POST /product-groups/batch where you can synchronize all product groups from production systems. The batch method allows you to synchronize multiple product groups in a tree structure where you can mark parent groups if needed.
The last synchronization endpoint is for the products themselves. Please use the API call of the endpoint POST /products/batch. In this endpoint, you can synchronize multiple products and identify their brands and product groups.
We recommend you synchronize brands, groups, and products depending on your needs (when a new entity appears in your system or when it is changed). Like brands, please consider the amount of records in one request for each endpoint.
To avoid problems during synchronization, we recommend you keep an order of synchronization this way:
1. Product brands
2. Product groups
3. Products

Newsletter sign-up and other operations

UNISCITI AL NOSTRO CLOUD

Sei pronto ad incontrare CareCloud?

Compila i tuoi dati di contatto per ottenere risposte alle domande che hai su CareCloud: dalla descrizione del prodotto ai prezzi, oppure una chiacchierata informale sui tuoi clienti e sulla tua attività.

Uno dei nostri esperti ti contatterà quanto prima possibile.

Inviando questo modulo, confermi di accettare il trattamento dei tuoi dati personali da parte di Cortex e di essere contattato per soddisfare la tua richiesta. I tuoi dati saranno eliminati dopo che avremo soddisfatto la tua richiesta, a meno che non venga stipulato un accordo reciproco per un ulteriore trattamento. I tuoi dati sono al sicuro.

Integrate Your Production System

Use CareCloud platform REST API to integrate with a production system (BI, DWH, Booking, Accounting, Warehouse etc.)

Setup and integration

Use Cases

Quickstart

Authentication

API Tools

Webhooks

API tools set

Postman Collection

SDK in PHP

PHP API client

Use cases

Customer account operations

Sending purchases

Check out process

Newsletter sign-up and other operations

UNISCITI AL NOSTRO CLOUD

Sei pronto ad incontrare CareCloud?

Favourite Links

About Us

Contact Us

Headquarters: