Připojení se k API

K tomu, abyste se mohli připojit k našemu REST API potřebujete následující:

• API endpoint: https://clouderis.cz/api

• Dokumentace pro vývojáře: https://clouderis.cz/api/index.html

• Tarif, který poskytuje možnost připojit se k API (tj. START nebo PROFI)

• API klíč (Api-Key)

Získání API klíče a zprovoznění přístupu k API na Vašem účtu

Pokud máte správný tarif, pak je zprovoznění velice jednoduché. Stačí navštívit nastavení účtu a tam otevřít záložku: Nastavení API

Zde stačí kliknout na "Generovat nový API klíč" a ten se vzápětí objeví ve vrchním poli. I přesto, že se snažíme zachovat API funkcionalitu minimální, API klíč, který se dostane do nepovolaných rukou, může stále být bezpečnostní riziko.

Pokud budete chtít zamezit přístup k Vašemu účtu skrze API, stačí API klíč vymazat.

Mějte na paměti, že jakmile se rozhodnete smazat API klíč, není se možné k němu vrátit a je nutné generovat nový. Tj. klienti, kteří do té doby používali předchozí klíč jej budou muset aktualizovat.

Použití API klíče

Získaný API klíč je potřeba vložit do hlavičky dotazu. Hlavička by měla mít Api-Key položku s hodnotou klíče

Zde je příklad vytvoření dotazu pomocí CURL nástroje:

curl -X 'GET' \
  'https://clouderis.cz/api/workitems/types' \
  -H 'accept: application/json' \
  -H 'Api-Key: <YourKey>'

V další sekci jsou komplexnější příklady založení nového zákazníka či zakázky.