BizKitHub

API pro informace o zákaznickém účtu

Když je token platný, odpověď obsahuje následující pole.

Naposledy aktualizováno 1. srpna 2026

Endpoint account-info vrací kompaktní snímek aktuálně přihlášeného nakupujícího. Toto je endpoint, který výkladní skříň volá při každém vykreslení stránky, aby určila „kdo se na tuto stránku právě dívá a zda potřebujeme zobrazit tlačítko pro přihlášení nebo menu účtu“. Pamatujte, že tento endpoint záměrně nevrací kompletní profil kontaktu — to by bylo náročnější, než většina vykreslení stránek potřebuje, a pole, která vrací, jsou již dostatečná pro vykreslení widgetu účtu, rozhodování o uživatelském rozhraní souvisejícím s kreditem a omezení přístupu k prémiovému obsahu. Pro pole, která zde nejsou zpřístupněna (adresa, historie komunikace, historie objednávek), zavolejte konkrétní endpoint, který je vlastní. Toto je jeden ze tří endpointů pro integraci výkladní skříně pro účty nakupujících, společně s customer register API a customer login API. Pro koncepty za kontakty, cuRefNo, kreditem a skóre důvěry, viz článek Contacts.

Endpoint

GET https://api.bizkithub.com/contact/v1/get-account-info?identityId=xxx

identityId je neprůhledný token relace vrácený customer login API. Autentizace probíhá pomocí standardního parametru apiKey (viz článek API key).

Odpověď

export type PublicCustomerAccountInfoResponse =
| { loggedIn: false }
| {
loggedIn: true;
identityId: string;
cuRefNo: string;
creditBalance: number;
email: string;
phone?: string;
firstName?: string;
lastName?: string;
companyName?: string;
premium?: boolean;
ban?: boolean;
};

Odpověď pro odhlášeného uživatele

Pokud token není rozpoznán (chybí, vypršel, byl zrušen), odpovědí je jediná hodnota { loggedIn: false }. Výkladní skříně by to měly chápat jako „odhlásit nakupujícího a zobrazit UI pro přihlášení“.

Odpověď pro přihlášeného uživatele

Když je token platný, odpověď obsahuje následující pole.

VlastnostTypVýznam
loggedIntrueOznačení, že nakupující je ověřen a token je platný.
identityIdstringStejný token, který jste dodali — zopakován pro symetrii a diagnostické párování.
cuRefNostringExterní referenční číslo zákazníka (16 znaků). Bezpečné pro zobrazení nakupujícímu.
creditBalancenumberAktuální použitelný zůstatek kreditu.
emailstringE-mailová adresa nakupujícího.
phonestringTelefonní číslo v normalizovaném formátu +<prefix> <value> (viz Phone normalisation).
firstNamestringJméno.
lastNamestringPříjmení (zahrnuje i druhé jméno, pokud je relevantní).
companyNamestringNázev společnosti — subjekt, který nakupující zastupuje, vlastní nebo pro něj pracuje.
premiumbooleanZda je nakupující prémiovým zákazníkem.
banbooleanZda je nakupující aktuálně zablokován.

Jednotlivci vs společnosti

Pokud kontakt reprezentuje společnost spíše než osobu, platforma vrátí companyName bez firstName nebo lastName. Pokud jsou přítomny všechny tři, kontakt je fyzická osoba jednající za nebo reprezentující tuto společnost — fakturace je pak vždy účtována společnosti a osobní jméno je pouze doplňková informace.

Stav a aktuálnost relace

Odpověď odráží aktuální stav relace na straně serveru v okamžiku volání. Pokud operátor zneplatní relace nakupujícího z administrace mezi dvěma voláními, druhé volání okamžitě vrátí { loggedIn: false } — neexistuje žádná klientská cache k invalidaci. Díky tomu je tento endpoint spolehlivý jako kontrola autentizace na výkladní skříni pro každý požadavek.

Související články

  • Customer register API — vytvoření nového účtu nakupujícího.
  • Customer login API — přihlášení nakupujícího a získání identityId.
  • Contacts — průvodce správou pokrývající cuRefNo, kredit, hodnocení kvality a blokování.
  • API key — jak autentizovat požadavek.

Související články