6.2

Metadata o CRM

Při psaní klienta, který se bude připojovat na CRM si můžete ověřit základní informace o vzdáleném CRM pomocí následujícího volání.

GET /api/about

Získání metadat o CRM. Jedná se o veřejný koncový bod, tj. klient se nemusí autorizovat.

Odpověď (application/json)

200 OK

{
  "crmId":"ANNECA", /* Unikátní kód CRM - 6 znaků, obvykle velká písmena a číslice*/
  "mode":100,       /* Stav systému: 100 = ok, běží;  5 = probíhá údržba (nelze se připojovat) */
  "partyId":2,      /* Kód kontaktu (reprezentující firmu, provozující systém) v adresáři CRM */
  "name":"Dobrý nápoj s.r.o.",  /* Název kontaktu / CRM */
  "country":"CZ",   /* Kód země */
  "language":"cs",  /* Kód jazyka */
  "timeZone":"Europe/Prague", /* Časová zóna */
  "url":"https://crm.dobrynapoj.cz",  /* URL adresa CRM nastavená administrátorem */
  "version": [ 6, 3, 0, 0 ] /* Four-part version number MAJOR, MINOR, PATCH, BUILD */
}

Pokud je hodnota v parametru mode jiná, než 100, CRM není připravené přijímat požadavky a většiná volání API nejspíš selže interní chybou.