Use case
ČESKÁ VERZE Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Curabitur ligula sapien, pulvinar a vestibulum quis, facilisis vel sapien. Donec quis nibh at felis congue commodo. Nullam rhoncus aliquam metus. Mauřis tincidunt sem sed arcu. Nam sed tellus id magna elementum tincidunt. Maecenas lorem. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Zde najdete podrobné popisy konkrétních případů použití pro vaše potřeby. Inspirujte se popisem osvědčených postupů pro integraci rozhraní REST API platformy CareCloud s vaší aplikací a usnadněte si práci. Použití souvisejících Use case vám ušetří čas i peníze!
Tento use case se může týkat integrace e-shopu nebo jiného produkčního systému, kde potřebujete přístup ke všem údajům zákazníka a požadujete od něj ověření prostřednictvím přihlašovací obrazovky.
Ověření zákazníka doporučujeme provést následujícím způsobem:
- Zobrazte zákazníkovi přihlašovací formulář.
- Můžete zobrazit výběr identifikátoru zákazníka. Rozhraní CareCloud API v současné době podporuje možnosti pro e-mail a číslo karty zákazníka.
- Případně můžete nechat zákazníka vyplnit jeho identifikátor bez výběru typu a následně na vaší straně (zpracování formuláře) rozhodnout, zda vyplnil e-mail nebo zákaznickou kartu. K rozhodnutí můžete použít běžné výrazy.
- Zákazník vyplní své přihlašovací údaje a odešle formulář.
- Aplikace ověřuje vstupy (formát e-mailu, formát karty zákazníka, formát hesla) a v případě neplatného vstupu informuje zákazníka příslušnou zprávou.
- Pokud zákazník zadá všechny vstupy správně, aplikace ověří pověření vůči rozhraní CareCloud API pomocí POST /customers/actions/verify-credentials volání.
- Předpokládejme, že rozhraní CareClould API v reakci zákazníka ověří. V takovém případě získáte z rozhraní CareCloud API ID zákazníka, které můžete použít pro příjem dalších informací o zákazníkovi, jako jsou nákupy, rezervace, věrnostní informace nebo údaje o zákazníkovi.
- Pokud je ověření neúspěšné, budete o tom informováni příslušnou zprávou z rozhraní API služby CareCloud. V závislosti na této zprávě můžete ve své aplikaci zobrazit zprávu pro zákazníka.
- Podstatnou informací je, že tento případ použití byl navržen pouze pro ověření, takže neznamená, že zákazník byl přihlášen do služby CareCloud. Pokud chcete zákazníka přihlásit, musíte mít tuto informaci na své straně.
Tento use case se může týkat integrace e-shopu nebo výrobního systému, kde potřebujete přístup k údajům více zákazníků nebo vyhledat zákazníka podle jeho identifikátorů (e-mail, telefonní číslo nebo jméno).
Doporučujeme vyhledávat data zákazníka následujícím způsobem:
- Pokud potřebujete vyhledat data jednoho nebo více zákazníků, použijte volání GET /customers. Chcete-li vyhledat jednoho nebo více zákazníků, musíte znát jejich e-mail, telefonní číslo, jméno, příjmení nebo datum narození.
- Údaje přidejte do parametrů dotazu. Čím více parametrů vyplníte, tím lepší a přesnější bude výsledek. V této metodě můžete získat více výsledků, pokud je hodnota parametru obecná, například "name=John".
- Odpověď obsahuje informace o zákazníkovi, včetně ID, osobních údajů nebo souhlasu, které můžete podle potřeby zpracovat.
- Pokud chcete vyhledat jednoho konkrétního zákazníka a očekáváte pouze jeden výsledek vyhledávání, použijte metodu akce GET /customers/actions/search-customers.
- Použijte striktní režim v parametrech dotazu. V tomto režimu musíte znát jméno, příjmení, datum narození a číslo karty zákazníka.
- Pokud má CareCloud tohoto zákazníka, dostanete ID.
- Chcete-li získat přístup k údajům zákazníka, musíte provést jedno další volání rozhraní API služby CareCloud, do kterého přidáte ID zákazníka z předchozího volání jako parametr cesty GET /customers/{customer_id}.
- Každé volání nebo metoda z předchozích bodů vrací struktury s ID zákazníka. Toto ID lze použít u jiných zdrojů jako parametr cesty k omezení výsledků vázaných na zákazníka. Například zákaznické poukázky GET /customers/{customer_id}/vouchers nebo zákaznické karty GET /customers/{customer_id}/cards nebo zákaznické vlastnosti GET /customers/{customer_id}/property-records a další najdete v referenční příručce API: https://developers.crmcarecloud.com/#tag/Customers
Tento use case se může týkat integrace mobilní aplikace nebo zákaznického portálu, kde potřebujete přístup k údajům přihlášených zákazníků.
Doporučujeme vyhledávat data zákazníka následujícím způsobem:
- Pro přístup k údajům zákazníka v tomto případě použití je povinné, aby byl zákazník přihlášen. Pokud potřebujete vědět, jak přihlásit zákazníka, podívejte se na use case Log in and log out customer.
- Pro přístup k osobním údajům zákazníka použijte zdroj GET /customers.
- Nemusíte přidávat žádnou cestu ani parametr dotazu. CareCloud API vrátí informace o přihlášeném zákazníkovi.
- Odpověď obsahuje informace o zákazníkovi, včetně ID, osobních údajů nebo souhlasu, které můžete podle potřeby zpracovat.
- Pokud chcete získat přístup k rozšířeným údajům o zákazníkovi - jeho vlastnostem, použijte následující koncový bod GET customers/property-records.
Tento use case se může týkat mobilní aplikace nebo integrace zákaznického portálu, kde se musíte přihlásit k účtu zákazníka, abyste získali přístup k jeho osobním údajům nebo jiným datům.
Tento proces vyžaduje, aby zařízení mělo token aplikace pro přístup k rozhraní API služby CareCloud. Postup pro získání a používání aplikačních tokenů naleznete v části Authentication section.
Doporučujeme vytvořit přihlašovací proces následujícím způsobem:
- Prvním krokem je získání přihlašovacího jména a hesla zákazníka prostřednictvím přihlašovací obrazovky aplikace. Vzhledem k tomu, že ověření přihlašovacích údajů probíhá z bezpečnostních důvodů na serverech platformy CareCloud, nemusíte přihlašovací jméno a heslo zákazníka ukládat do aplikace.
- Po odeslání formuláře zákazníkem by aplikace měla ověřit přihlašovací jméno (obvykle e-mailovou adresu) a heslo podle požadavků z dokumentace API platformy CareCloud.
- Úspěšná validace spustí metodu akce přihlášení s názvem POST /tokens/{token_id}/actions/login.
- Pokud je vrácena chybová zpráva, je třeba postupovat podle pokynů v závislosti na zprávě.
- V případě úspěšného výsledku aplikace obdrží identifikaci zákazníka.
- Pokud je zákazník přihlášen, můžete většinu zdrojů v rozhraní CareCloud API volat bez identifikace zákazníka. Informace o přihlášeném zákazníkovi jsou například k dispozici v koncovém bodě GET /customers. ID není nutné, CareCloud zákazníka rozpozná a vrátí jeho informace.
- Pokud zákazník požaduje odhlášení, volejte metodu API akce GET /tokens/{token_id}/actions/logout.
- Po odhlášení může aplikace volat pouze zdroje dostupné bez přihlášených zákazníků.
- Existují pouze dva způsoby odhlášení zákazníka, první je přes metodu odhlášení a druhý odhlásí zákazníka, když token aplikace ztratí platnost. Pro více informací o tokenu aplikace využijte use case "Mobile application/customer portal access to CareCloud API"
Aktualizace zákazníka je důležitý proces, který je nutné provést správně, abyste zachovali jeho údaje. Pro aktualizaci postupujte podle tohoto use case:
- Pro aktualizaci potřebujete nejprve znát původní údaje zákazníka. Pokud nemáte v systému uloženy všechny údaje o zákazníkovi, musíte informace o zákazníkovi vyvolat pomocí volání API GET /customers, kde získáte všechny údaje o zákazníkovi. Nyní můžete začít aktualizovat údaje o zákaznících.
- Když máte k dispozici údaje o zákaznících, můžete je upravit a aktualizovat pomocí koncového bodu PUT /customers. Tento koncový bod musí obsahovat všechny informace o zákaznících, protože aktualizujete všechny jejich údaje. Všechny parametry, které nebudou v požadavku nastaveny, budou ztraceny kvůli principu HTTP PUT verb.
- Úspěšná aktualizace je reprezentována kódem 204 HTTP. V případě chyby je v chybové zprávě vysvětlen problém.
- Pokud potřebujete aktualizovat vlastnosti zákazníka, použijte koncový bod PUT /customers/property-records/{property_record_id}. Tam můžete upravit stávající vlastnosti.
Tento use case lze aplikovat na mobilní aplikaci nebo integraci zákaznického portálu, kdy si zákazník potřebuje změnit heslo.
Doporučujeme změnit heslo zákazníka následujícím způsobem:
- Pokud si zákazník nepamatuje své heslo, může požádat o jeho změnu. Všechna hesla jsou bezpečně uložena a chráněna na serverech CareCloud, takže aplikace zákazníka nemusí ukládat hesla a riskovat tak únik dat.
- Zákazník do formuláře vyplní kontaktní údaje (e-mail, telefonní číslo, případně další, pokud to projekt umožňuje). Aplikace ověří strukturu kontaktu.
- Aplikace odešle požadavek do Carecloud metody akce POST /tokens/{token_id}/actions/send-password-setup-email.
- CareCloud ověří platnost kontaktu a zkontroluje jeho existenci v databázi zákazníků. Pokud kontakt existuje, CareCloud odešle zprávu s odkazem na změnu hesla. Uživatelé platformy CareCloud mohou v případě potřeby nakonfigurovat šablonu kontaktu (e-mail/telefon) v aplikaci CareCloud Kampaně & Cílové skupiny.
- Zákazník zprávu otevře a klikne na odkaz.
- Zákazník je přesměrován na formulář pro změnu hesla v aplikaci CareCloud.
- Zákazník vyplní formulář s novým heslem a aplikace ověří množství a typ znaků v hesle.
- Po úspěšné změně hesla je zákazník přesměrován podle zdroje zákazníka, který mu byl přidělen. Adresu URL pro předávání je možné nastavit v administraci zdrojů zákazníků v CareCloudu.
Tento use case se vztahuje na e-shop nebo integraci s produkčním systémem, kdy si zákazník potřebuje změnit heslo v platformě CareCloud.
Doporučujeme změnit heslo zákazníka následujícím způsobem:
- Pokud si zákazník nepamatuje své heslo, může požádat o jeho změnu.
- Zákazník vyplní e-mailovou adresu do formuláře žádosti. Aplikace ověří strukturu e-mailové adresy.
- Po ověření e-mailové adresy aplikace zkontroluje její existenci v CareCloud pomocí volání API GET /customers. Pokud e-mailová adresa existuje, aplikace odešle e-mail s odkazem na změnu hesla.
- Zákazník otevře e-mail a klikne na odkaz.
- Zákazník je přesměrován na formulář žádosti o změnu hesla.
- Zákazník vyplní formulář s novým heslem a aplikace ověří množství a typ znaků v hesle (Musí dodržet omezení rozhraní API služby CareCloud pro heslo PUT /customers/{customer_id}).
- Po úspěšném ověření musí aplikace aktualizovat nové heslo na účtu zákazníka. Za tímto účelem musí aplikace provést volání rozhraní API služby CareCloud PUT /customers/{customer_id} s novým heslem.
- Po úspěšné změně hesla je zákazník přesměrován na přihlašovací formulář.
PŘIPOJTE SE DO CLOUDU
Chcete vědět více o funkcionalitách platformy 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í!
Odesláním tohoto formuláře potvrzujete svůj 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.