API

API (Application Programming Interface) poskytuje datové rozhraní pro přístup k datům v rámci konkrétního rezervačního systému (konkrétního subjektu). Pomocí programového přístupu je díky API možné získávat informace o rezervacích a zpracovávat je v dalších/externích aplikacích.

Níže uvedený popis datového rozhraní je určen pro odborníky a obsahuje technické informace a specifikace!

Tato funkcionalita je dostupná pouze v balíčku PREMIUM.

Obecné informace

REST API je dostupné na adrese https://reenio.cz/cs/api/v1/admin/.

Pro veškerou příchozí i odchozí komunikaci s API je použito kódování UTF-8.

Pokud není uvedeno jinak, je datum a čas používaný při komunikaci s API v časové zóně UTC. Formát data a času se řídí standardem ISO 8601.

Autentizace

Přístup k REST API je zabezpečen pomocí API klíče, který získáte po přihlášení do administrace systému reenio (https://reenio.cz/cs/admin/#/settings/api). Tento klíč je vždy svázán se subjektem a uživatelem, který jej vytvořil. Díky tomu máte při komunikaci s API stejná oprávnění jako daný uživatel. API klíč udržujte vždy v tajnosti. V případě podezření na jeho odcizení jej stačí v administraci odstranit a vytvořit nový.

Klíč je potřeba předávat v rámci všech požadavků na API a to v HTTP dotazu prostřednictvím Authorization: Bearer <ApiKey>. Například:

Authorization: Bearer Ky3Ancs1D2Nd33W6MQ2e9Db5

Seznam zákazníků

Požadavek
GET /customer/list
Hlavička požadavku
Název hlavičky Hodnota
Accept application/json
Authorization Bearer <ApiKey>
Parametry požadavku
Název parametru Popis parametru Povinný Datový typ
page Slouží pro stránkování výsledků. Udává číslo stránky. ne int

Detail zákazníka

Požadavek
GET /customer/detail/{id}
Hlavička požadavku
Název hlavičky Hodnota
Accept application/json
Authorization Bearer <ApiKey>
Parametry požadavku
Název parametru Popis parametru Povinný Datový typ
id ID zákazníka ano int

Seznam rezervací

Požadavek
GET /reservation/list
Hlavička požadavku
Název hlavičky Hodnota
Accept application/json
Authorization Bearer <ApiKey>
Parametry požadavku
Název parametru Popis parametru Povinný Datový typ
start Datum počátek požadovaného období ve formátu ISO 8601. ano string
end Datum konce požadovaného období ve formátu ISO 8601. ano string
includeCancelled Má výsledek obsahovat i stornované rezervace? ne bool
includeAlternate Má výsledek zahrnovat i náhradníky? ne bool

Detail rezervace

Požadavek
GET /reservation/detail/{id}
Hlavička požadavku
Název hlavičky Hodnota
Accept application/json
Authorization Bearer <ApiKey>
Parametry požadavku
Název parametru Popis parametru Povinný Datový typ
id ID rezervace ano int

Seznam zdrojů typu "místo"

Požadavek
GET /resource/place
Hlavička požadavku
Název hlavičky Hodnota
Accept application/json
Authorization Bearer <ApiKey>

Seznam zdrojů typu "služba"

Požadavek
GET /resource/service
Hlavička požadavku
Název hlavičky Hodnota
Accept application/json
Authorization Bearer <ApiKey>

Seznam zdrojů typu "zaměstnanec"

Požadavek
GET /resource/employee
Hlavička požadavku
Název hlavičky Hodnota
Accept application/json
Authorization Bearer <ApiKey>

Detail přihlášeného uživatele

Přihlášeným uživatele se myslí uživatel, pro nějž byl vystaven API klíč.

Požadavek
GET /user/info
Hlavička požadavku
Název hlavičky Hodnota
Accept application/json
Authorization Bearer <ApiKey>