API dokumentace

tutut.cz disponuje vlastním REST API, které je dostupné všem firemní uživatelům. Pomocí API je možné získat čísleníky a spravovat inzerci, včetně stažení veškerých inzerátů přihlášené společnosti.

Schéma REST API

Schéma API je dostupné ve formátu OpenAPI schema 3.0, které je možné zobrazit ve Swagger UI na adrese:

tutut.cz REST API schéma

Autorizace

Pro využití API je potřeba aby byl klient autorizován. Autorizace probíhá pomocí API klíče, který je možné vygenerovat v uživatelské administraci společnosti.

Vygenerovaný API klíč je potřeba použít v každém requestu v hlavičce s názvem X-API-KEY.

Vytvoření inzerátu

Pro vytvoření inzerátu je určen endpoint POST /api/v1/advert, který vytvoří inzerát se stavem in-creation.
Pro zveřejnění inzerátu je potřeba nejprve nahrát fotografie pomocí POST /api/v1/advert/image.
Následně je možné inzerát zveřejnit: PATCH /api/v1/advert/publish.
Inzerát je uveden do stavu published pouze pokud má společnost aktivní tarif.