API pro partnery

REST rozhraní CoolCMS. Slouží mobilním aplikacím, partnerským systémům a vlastním klientům.

Kde začít

1. Začínáme — první požadavek za pět minut.
2. Autentizace — jak získat token.
3. Formát odpovědi — 🔴 přečtěte, než začnete psát parser.
4. CRUD vzor — čtení a zápis.
5. Chybové kódy.

Tvar adresy

https://<váš-web>/api/<modul>/<zdroj>/<akce>

Volitelně s jazykovým prefixem: /en/api/…. Výchozí jazyk je čeština.

Moduly a jejich zdroje jsou v referenci.

🔴 Tři věci, které překvapí každého

Přečtěte je teď, ať je nemusíte hledat v ladicím nástroji.

1. Parametry se posílají v adrese, ne v těle požadavku

I u zápisu. POST s JSON tělem projde jako „chybí data“. Jediná výjimka jsou přihlašovací endpointy, které naopak čtou formulářové tělo. Podrobně CRUD vzor.

2. Čtení a zápis mají různý tvar odpovědi

Čtení vrací items a _references bez pole success. Zápis vrací obálku s success. Jednotný parser podle success napsat nejde. Podrobně Formát odpovědi.

3. Chyby chodí s kódem HTTP 200

Validace, „nenalezeno“ i konflikt. Stavový kód rozliší jen 401, 403, 429 a 204. Podrobně Chybové kódy.

Co API umí

Skupina	Akce
Čtení	get, get-by, get-all
Zápis	save, update-columns
Mazání	delete, delete-all
Strom	move-up, move-down, move-subtree, delete-node
Události	register-event

Specifikace

Strojová specifikace je na /api-docs.json, prohlížeč na /api-docs/.

Specifikace pokrývá zatím jen přihlašovací endpointy

Šest cest z několika stovek. Zbytek popisuje tenhle manuál. Nespoléhejte na generovaného klienta.