Antcas API

Antcas API umožňuje vyměňovat data mezi několika aplikacemi.

VAROVÁNÍ: Dbejte na bezpečnost při používání tohoto API. Používejte pouze TLS a nikdy nepoužívejte tento port na veřejně dostupné adrese.

Poznámka: Protože API musí při každém volání ověřovat token, může to vést k vyššímu zatížení systému.

Nastavení portu API

V Správě projektu lze přidat nový port API. Popis naleznete v kapitole Přiřadit port projektu.

Aby bylo možné vytvořit požadavek, musí být tento požadavek pomocí tokenu ověřen. Vytvoření tokenu je podrobněji vysvětleno v kapitole Správa tokenů.

Formáty a hodnoty

API podporuje několik vstupních formátů: HTTP dotazy, JSON a XML. Výstup může být v HTML, textu, JSON nebo XML. Kódování znaků je vždy UTF-8.

Poznámka: Volání prvkem v prohlížeči způsobuje chybu 428 (Precondition Required). Jedná se o ochranu proti XSS útoku, kterou nelze obejít. Tato ochrana zabraňuje hackerskému útoku na Antcas Control.

Při požadavku POST nebo PUT lze data zapsat do obsahu ve správném formátu. Každá proměnná je citlivá na velikost písmen, což znamená, že se rozlišuje mezi velkými a malými písmeny. Vracení však vždy probíhá v deklarovaném formátu. Formát výstupu lze specifikovat pomocí hlavičky nebo přes proměnnou format. Formát vstupu je vždy automaticky rozpoznán.

GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json

Následující formáty jsou podporovány v hlavičce a jako proměnná format:

Content-Type Proměnná Formát
application/json json JSON
application/xml xml XML
text/plain text Text
text/csv csv CSV*
(ostatní) html HTML

*Podporováno pouze jako formát výstupu.

Poznámka: Formáty Text a CSV obsahují UTF-8 BOM. Tento lze pomocí proměnné bom=FALSE deaktivovat.

Pokud je hodnota popsána několika formáty, má poslední formát prioritu:

  • HTTP hlavička (pouze formát výstupu přes Content-Type)
  • GET
  • POST
  • JSON/XML (jako obsah POST nebo PUT)

Vstupní proměnné

Následující proměnné jsou globálně definovány.

Proměnná Popis
format Formát výstupu.
bom BOM v formátu UTF-8. Výchozí hodnota je TRUE.
key Čte pouze jednu proměnnou, která byla deklarována. Tato metoda je neefektivní, protože všechny data jsou připravena a poté filtrována. Měla by se používat pouze u malých množství dat.
header Výstup hlavičky. Výchozí hodnota je TRUE.
compact Spojuje všechny podprvky dohromady. Pokud není deklarována boolean hodnota, použije se tato hodnota ke spojení proměnných. V opačném případě se použije hodnota ..
values Vrací pouze hodnoty a ne jména proměnných. Tato možnost je k dispozici pouze pro HTML, CSV a Text.
minimal Alias pro header=FALSE, compact=minimal a values=TRUE.
csvdel Oddělovač CSV. Výchozí hodnota je ;
csvenc Závorky pro obalení CSV. Výchozí hodnota je "
csvesc Únikové znaky CSV. Výchozí hodnota je \

Následující proměnné lze používat globálně, stejně jako pro jednotlivé proměnné. Aby bylo možné ovlivnit jednu konkrétní proměnnou, je definována následovně:

time*:hr=true

Výše uvedený příklad ovlivňuje všechny proměnné začínající na time a samotnou proměnnou time. Zkontrolovány jsou všechny pravidla postupně. Poslední vhodná pravidlo má přednost. Hledání probíhá pomocí regulárního výrazu.

Proměnná Popis
hr Čitelné pro lidi. Proměnné se, pokud je to možné, přeměňují na data čitelná pro lidi. Výchozí hodnota je TRUE pro formáty HTML, CSV a Text.
numdec Počet míst za desetinnou čárkou.
numths Oddělovač tisíců.
numdot Desetinné oddělovače.
prefix Text přidat před proměnnou.
suffix Text přidat za proměnnou.

Cesty

V následujících kapitolách jsou definovány všechny aplikace API.

Podřízené Stránky