Antcas API

Azonosítók cseréjét lehetővé teszi az Antcas API több alkalmazás között.

FIGYELMEZTETÉS: Figyeljen a biztonságra az API használatakor. Használja csak a TLS-t, és ne használja soha nyilvánosan elérhető címen.

Megjegyzés: Mivel az API minden hívásnál ellenőrzi a tokenet, ez nagyobb rendszerterhelést eredményezhet.

API-port beállítása

A Projektkezelés alatt új API-portot lehet hozzáadni. A leírást a Port hozzárendelése a projekthez fejezetben találja.

Azonban ahhoz, hogy egy kérés létrehozható legyen, ezt az Token segítségével kell hitelesíteni. A token létrehozásának részleteit a Token kezelése fejezetben találja.

Formátumok és értékek

Azonosítók több bemeneti formátumot támogatnak: HTTP-lekérdezések, JSON és XML. A kimenet HTML, szöveg, JSON vagy XML lehet. A karakterkódolás mindig UTF-8.

Megjegyzés: Ha egy elem hívja meg a böngészőben, akkor az 428 (Precondition Required) hibát eredményezi. Ez az XSS-Attack védelme, ezt nem lehet kikerülni. Ez megakadályozza a hacker támadásokat az Antcas Control ellen.

POST vagy PUT kérés esetén az adatok a megfelelő formátumú tartalommal írhatók felül. Minden változó nagy- és kisbetűre érzékeny, azaz megkülönbözteti a nagy- és kisbetűket. A visszatérés azonban mindig a deklarált formátumban történik. A kimeneti formátumot a fejléc vagy a format változó segítségével lehet leírni. A bemeneti formátum mindig automatikusan felismerhető.

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

A következő formátumokat támogatja a fejléc és a format változó:

Content-Type Változó Formátum
application/json json JSON
application/xml xml XML
text/plain text Szöveg
text/csv csv CSV*
(egyéb) html HTML

*Csak kimeneti formátumként támogatott.

Megjegyzés: A szöveg és CSV formátumok tartalmazzák az UTF-8 BOM-t. Ezt a bom=FALSE változó segítségével lehet letiltani.

Ha egy érték több formátumban van megadva, akkor az utóbbi formátumnak van előnyben:

  • HTTP-fejléc (csak kimeneti formátum a Content-Type-n keresztül)
  • GET
  • POST
  • JSON/XML (mint POST vagy PUT tartalom)

Bemeneti változók

A következő változókat globálisan definiálták.

Változó Leírás
format A kimenet formátuma.
bom BOM az UTF-8 formátumban. Az alapértelmezett érték TRUE.
key Csak egy deklarált változó olvasása. Ez az eljárás hatékonytalan, mivel minden adat előkészítése után szűrik. Csak kis adattömbök esetén használja.
header Fejléc kiírása. Az alapértelmezett érték TRUE.
compact Összevonja az összes alulról elemet. Ha nincs logikai érték deklarálva, akkor ezt a értéket használja a változók összevonásához. Ellenkező esetben a . értéket használja.
values Csak az értékeket és nem a változóneveket adja vissza. Ez az opció csak HTML, CSV és szöveg esetén érhető el.
minimal Alias header=FALSE, compact=minimal és values=TRUE.
csvdel CSV-elválasztó. Az alapértelmezett érték ;
csvenc CSV-zárójel. Az alapértelmezett érték "
csvesc CSV-másodlagos karakter. Az alapértelmezett érték \

A következő változókat globálisan, valamint egyes változók számára is használhatja. Egyetlen változó megcímzéséhez a következőképpen definiálható:

time*:hr=true

A fenti példa minden olyan változót érint, amely time-vel kezdődik és időtartamot jelöl. Ellenőrizve mindent sorban. Így az utolsó illeszkedő szabálynak van előnyben. A keresés reguláris kifejezés segítségével történik.

Változó Leírás
hr Ember olvasható. A változókat, ha lehető, ember által olvasható adatokká alakítják át. Az alapértelmezett érték TRUE az HTML, CSV és szöveg formátumok számára.
numdec A tizedesjegyek száma.
numths Ezeres elválasztó.
numdot Tizedespont.
prefix Szöveg hozzáadása a változó előtt.
suffix Szöveg hozzáadása a változó után.

Útvonalak

A következő fejezetekben az API összes alkalmazását definiálták.

Aloldalak