> For the complete documentation index, see [llms.txt](https://clouderis.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://clouderis.gitbook.io/docs/integrace-pro-vyvojare/rest-api.md).

# Veřejné API

Veřejné REST API umožňuje bezpečně automatizovat vybrané operace Clouderisu. Aktuální interaktivní schéma a modely jsou dostupné ve [Swagger UI](https://clouderis.cz/api/index.html).

## Co API pokrývá

* zakázky – hledání, detail, vytvoření, částečná aktualizace, komentáře, položky, změny a komunikace;
* zákazníky – hledání, detail a vytvoření nebo aktualizaci;
* produkty/projekty – hledání a detail;
* skladové položky – hledání;
* rezervace – hledání, detail, položky k rezervaci, dostupnost a vytvoření;
* provozovny a číselníky typů a stavů zakázek.

API nepokrývá všechny funkce uživatelského rozhraní. Veřejné endpointy nejsou určené pro přímou práci s platbami, tarify, přepravou nebo nastavením integrací.

Pokud místo pravidelného dotazování potřebujete dostávat změny zákazníků, rezervací a zakázek automaticky, použijte [Webhooky](/docs/integrace-pro-vyvojare/webhooky.md). Webhookové payloady využívají veřejné modely popsané tímto API.

## Základní pravidla

* Základ URL je `https://clouderis.cz/api`.
* Každý požadavek posílá klíč v hlavičce `Api-Key`.
* JSON posílejte jako `Content-Type: application/json`.
* ID modelů jsou v JSON často textové řetězce, i když obsahují číslo.
* Zakázka se v URL identifikuje svým alfanumerickým `code`, nikoli interním ID.
* Stránkované endpointy vracejí `items`, `totalCount`, `page` a `pageSize`.

Pokračujte na [Připojení a autentizace](/docs/integrace-pro-vyvojare/rest-api/pripojeni-se-k-api.md), [Přehled endpointů](/docs/integrace-pro-vyvojare/rest-api/endpointy.md) a [Příklady požadavků](/docs/integrace-pro-vyvojare/rest-api/ukazka-dotazu.md).