Integrate with your POS or Cash Desk App

Use CareCloud platform REST API to integrate with POS system or Cash Desk application

Setup and integration

You find here 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!

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 →

REST API reference guide

Complete list of API resources

Structure of URL, parameters, and versioning

List of error codes and HTTP verbs

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.

You find here 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 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

Customer personal data update

Updating the customer is a really important process and it is crucial to do it right, so you don't lose any data of the customer. For 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 multiple ways, that you can find in other use cases like login the customer, search the customer or customer verification and others.
The moment, you have customer ID, you can update data of the customer with endpoint PUT /customers. This endpoint has to contain all the information of the customer, because you are updating all customer data. All parameter that wont be set in the request will be lost, because of the principle of the HTTP PUT verb.
Successful update is represented by 204 HTTP code, in case of error, the error message explains the issue.

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 following way:

The customer can request a change if he doesn't remember his password. The application has to request a change of password through the CareCloud API.
The customer fills email address on the form. The application validates the email address structure.
The application validates the email address and checks its existence with CareCloud 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.
After successful validation, the application has to update a new password in CareCloud. For that, the application has to do 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.

JOIN OUR CLOUD

Ready to Meet CareCloud?

Fill in your contact details to get answers to the questions you have about CareCloud – from product description and pricing to casual talk about your customers and your business.

One of our experts will contact you soon.

Your Name Please enter your name.

Email Address Please enter a valid email address.

Phone Number Please enter a valid phone number.

Your Message Please type your message.

Please check the captcha to verify you are not a robot.

I agree with the processing of my personal data under the Privacy policy. Please check this field.

CONTACT ME

By submitting this form, you confirm that you agree to the processing of your personal data by Cortex and contacting you to fulfill your request. Your data will be deleted after we meet your request unless a mutual agreement on further processing has been concluded. Your data is secure.

Integrate with your POS or Cash Desk App

Use CareCloud platform REST API to integrate with POS system or Cash Desk application

Setup and integration

Quickstart

Authentication

REST API reference guide

API tools set

Postman Collection

SDK in PHP

PHP API client

Use cases

JOIN OUR CLOUD

Ready to Meet CareCloud?

Favourite Links

About Us

Contact Us

Headquarters: