Integrujte Váš produkční systém

Použijte REST API platformy CareCloud k integraci s produkčním systémem (BI, DWH, rezervační či booking systém, účetní systém, skladové hospodářství atd.)

Nastavení a integrace

Zde najdete kompletní příručku pro vývojáře k integraci REST API platformy CareCloud s vaší aplikací. Přečtěte si ji a zjistěte více o procesu integrace a usnadněte si první kroky pomocí odkazu Quickstart. Můžete se naučit, jak používat naše REST API a vytvářet první volání API. Tato příručka umožňuje snadnou autentizaci a bezpečné volání s ohledem na zabezpečení vašich dat. Najdete zde popis parametrů API a jeho verzování, strukturu URL, chybové kódy a HTTP volání.

Využijte REST API Guide platformy CareCloud

Quickstart

Jste tu nový? Začněte s Quickstart!

Naučte se využívat REST API

Vaše první volání API

ZJISTIT VÍCE →

Autentizace

Naučte se autentizovat s REST API

Jak získat bearer token?

Využívejte API snadno a rychle

ZJISTIT VÍCE →

REST API referenční příručka

Kompletní přehled API resource

Struktura URL, parametry a verzování

Přehled error kódů a HTTP volání

ZJISTIT VÍCE →

Sada API nástrojů

Takdy najdete nejsnazší způsob, jak začít používat CareCloud API. Stačí stáhnout "collection" a importovat ji do vaší instalace aplikace Postman. Během několika minut tak můžete sami volat CC API. Kromě toho se zde dozvíte, jak používat CareCloud API SDK, tedy sadu vývojových nástrojů včetně CareCloud PHP klienta, počínaje instalací balíčku, vytvořením klienta CC API a přístupem ke všem koncovým bodům CC API z objektu $client.

Navíc zde najdete základní stavební prvky Vašeho API PHP klienta, kterého si můžete následně upravit a přizpůsobit vaší implementaci. Dokumentace Open API 3.0 vám pomůže vygenerovat zmíněného CC API klienta a současně poskytne sadu nástrojů Open API.

Aplikace Postman

Instalujte aplikaci Postmen nebo využijte možnost online přístupu

Stáhněte si API kolekci do Postmena

Získáte průvodce až k prvnímu volání API

GitHub

PHP SDK

Snadná integrace

REST API SDK s velkým množstvím resource

Využití Best practice

GitHub

PHP API klient

Základ pro rychlou integraci

Možnost customizace

Přístup ke všem endpointům

GitHub

Use case

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.

PŘIPOJTE SE DO CLOUDU

Chcete vědět více o funkcionalitách CDP & CRM CareCloud?

Vyplňte své kontaktní údaje a my Vám rádi zodpovíme libovolný dotaz o CareCloud - řešení pro Váš obor, cenovou nabídku, přínosy pro Váš business - vše spolu nezávazně prodiskutujeme.

Náš expert se s Vámi brzy spojí!

Jméno Prosím, vyplňte své jméno.

E-mailová adresa Please enter a valid email address.

Telefonní číslo Prosím, vyplňte platné telefonní číslo.

Dotaz či zpráva Please type your message.

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

Souhlasím se zpracováním osobních údajů v souladu s dokumentem Ochrana soukromí. Please check this field.

ODESLAT

Odesláním tohoto formuláře poztvrzujete svů souhlas se zpracováním osobních údajů společností Cortex, a.s. a vyjadřujete souhlas s dalším kontaktem. Vaše údaje budou vymazány po ukončení naší komunikace, pokud nedojde k dohodě o jejich uchování. Vaše údaje jsou u nás zabezpečené v souladu s platnou legislativou.

Integrujte Váš produkční systém

Použijte REST API platformy CareCloud k integraci s produkčním systémem (BI, DWH, rezervační či booking systém, účetní systém, skladové hospodářství atd.)

Nastavení a integrace

Quickstart

Autentizace

REST API referenční příručka

Sada API nástrojů

Aplikace Postman

PHP SDK

PHP API klient

Use case

PŘIPOJTE SE DO CLOUDU

Chcete vědět více o funkcionalitách CDP & CRM CareCloud?

Oblíbené linky

O nás

Kontaktujte nás

Sídlo