API pro registraci zákazníka
export type CustomerRegisterErrorCode = keyof typeof CUSTOMER_REGISTER_ERROR_CODE;
Endpoint pro registraci vytváří novou žádost o registraci pro nakupujícího. Po úspěšném dokončení platforma odešle potvrzovací e-mail (kód šablony customer-register-account) na zadanou adresu; nakupující musí na něj kliknout, než bude účet použitelný pro přihlášení. Do té doby profil existuje, ale ještě není aktivován.Toto je jeden ze tří endpointů pro integraci s e-shopem pro účty nakupujících, spolu s API pro přihlášení zákazníka a API pro informace o zákaznickém účtu. Koncepty za kontakty, registrovanými účty a hosty naleznete v článku Kontakty.
Endpoint
POST https://api.bizkithub.com/contact/v1/register-account
Autentizace probíhá pomocí standardního parametru apiKey (viz článek API klíč).Tělo požadavku
export type CustomerRegisterRequest = {
email: string;
password: string;
name?: string;
phone?: string;
companyName?: string;
companyRegistrationNumber?: string;
taxIdentificationNumber?: string;
streetAddress?: string;
city?: string;
cityPart?: string;
stateRegion?: string;
postalCode?: string;
country?: string;
newsletter?: boolean;
primaryLocale?: string;
};
Minimální přijímané payload je syntakticky platný email a neprázdné password. Každé další pole je volitelné a může být přidáno do profilu později, buď prostřednictvím administrace, nebo opětovným odesláním s následnou objednávkou – platforma slučuje nové informace do profilu pomocí svých pravidel pro skórování kvality (viz Kontakty pro logiku slučování).Odpověď
export const CUSTOMER_REGISTER_ERROR_CODE = {
E001: 'Customer register failed.',
E002: 'Customer has been registered.',
E003: 'Customer account has been banned.',
E004: 'Too many registration attempts.',
} as const;
export type CustomerRegisterErrorCode = keyof typeof CUSTOMER_REGISTER_ERROR_CODE;
export type PublicCustomerRegisterAccountResponse =
| { success: false; errorCode: CustomerRegisterErrorCode; message: string }
| { success: true };
Chybové kódy
| Kód | Zpráva | Význam |
|---|---|---|
E001 | Customer register failed. | Obecná chyba registrace – obvykle chyba na straně platformy. Vzácné. |
E002 | Customer has been registered. | Nakupující je již registrován a potvrzen. Nasměrujte ho k přihlášení nebo resetování hesla. |
E003 | Customer account has been banned. | Obchodník zakázal jakoukoli interakci s tímto kontaktem. Registrace je odmítnuta. |
E004 | Too many registration attempts. | Příliš mnoho nevyřízených registrací pro tuto adresu bez dokončení ověření. Počkejte a zkuste to znovu. |
Omezení četnosti a limity
- Registrace je k dispozici pouze pro adresy, které mohou přijímat potvrzovací e-mail přes veřejný internet prostřednictvím konfigurace SMTP obchodníka. Adresy, které se trvale odrazí, jsou odmítnuty.
- Registrace je odmítnuta pro vestavěný účet anonymního zákazníka a pro jakýkoli kontakt označený jako zabanovaný.
- Pokud je vytvořena žádost o registraci, ale e-mail není nikdy potvrzen, nový pokus o registraci pro stejnou adresu je přijat pouze jednou za deset minut.
- Být „registrován“ je definováno nastavením hesla v profilu – nikoli samotnou existencí profilu. Profil může existovat roky jako host, než se nakupující zaregistruje.
Co se stane po úspěšném volání
- Potvrzovací e-mail je odeslán na zadanou adresu prostřednictvím e-mailového systému platformy.
- Nakupující klikne na potvrzovací odkaz, který aktivuje profil.
- Nakupující se nyní může přihlásit pomocí API pro přihlášení zákazníka.
- Po přihlášení e-shop načte profil prostřednictvím API pro informace o zákaznickém účtu.
Související články
- API pro přihlášení zákazníka — přihlaste registrovaného nakupujícího a získejte token relace.
- API pro informace o zákaznickém účtu — načtěte kompaktní profil přihlášeného nakupujícího.
- Kontakty — průvodce správou pokrývající kontakty, hodnocení kvality, anonymního zákazníka.
- API klíč — jak autentizovat požadavek.
- Chybové kódy — konvence chybových kódů platformy.