Antcas API
Antcas API omogućuje razmjenu podataka između više aplikacija.
| OPREZ: Pazite na sigurnost prilikom korištenja ove API. Koristite samo TLS i nikada ne koristite port na javnoj adresi. |
Napomena: Budući da API mora provjeriti token pri svakom pozivu, to može rezultirati većim opterećenjem sustava.
Postavljanje API porta
Pod Upravljanje projektom može se dodati novi
API port. Opis možete naći u poglavlju Port dodijeliti projektu.
Da bi se izvršio zahtjev, mora se provesti autentifikacija putem tokena. Stvaranje tokena detaljnije je objašnjeno u poglavlju Upravljanje tokenima.
Formati i vrijednosti
API podržava više ulaznih formata: HTTP upiti, JSON i XML. Izlaz može biti u obliku HTML-a, teksta, JSON-a ili XML-a. Kodiranje znakova je uvijek UTF-8.
Napomena: Poziv putem elementa u pregledniku rezultirat će greškom 428 (Precondition Required). To je zaštita od XSS napada, koju nije moguće zaobiti. Ona sprječava hackerski napad na Antcas Control.
Prilikom POST ili PUT zahtjeva, podatci se mogu upisati u odgovarajući format putem sadržaja. Svaka varijabla je osjetljiva na velika i mala slova, što znači da se razlikuje veliko od malog pisma. Vraćanje podataka uvijek se vrši u deklariranom formatu. Format izlaza može se opisati putem zaglavlja ili preko varijable format. Ulazni format se uvijek automatski prepoznaje.
GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json
Sljedeći formati podržani su u zaglavlju i kao varijabla format:
| Content-Type | Varijabla | Format |
|---|---|---|
| application/json | json | JSON |
| application/xml | xml | XML |
| text/plain | text | Tekst |
| text/csv | csv | CSV* |
| (drugi) | html | HTML |
*Podržano samo kao format izlaza.
Napomena: Formati Tekst i CSV sadrže UTF-8 BOM. Ovaj se može isključiti putem varijable bom=FALSE.
Ako je vrijednost opisana kroz više formata, prioritet ima posljednji format:
- HTTP zaglavlje (samo format izlaza putem Content-Type)
- GET
- POST
- JSON/XML (kao POST ili PUT sadržaj)
Ulazne varijable
Sljedeće varijable su globalno definirane.
| Varijabla | Opis |
|---|---|
| format | Format izlaza. |
| bom | BOM u UTF-8 formatu. Zadani je TRUE. |
| key | Čita samo jednu varijablu koja je deklarirana. Ova metoda je neefikasna, budući da se svi podaci pripremaju i filtriraju tek nakon toga. Treba ju koristiti samo za male količine podataka. |
| header | Ispisati zaglavlje. Zadani je TRUE. |
| compact | Sve podelemente spaja u sebe. Ako nije deklarirana boolean vrijednost, koristi se ova vrijednost da bi se varijable spojile. Inače se koristi vrijednost .. |
| values | Vraća samo vrijednosti, a ne imena varijabli. Ova opcija dostupna je samo za HTML, CSV i Tekst. |
| minimal | Alias za header=FALSE, compact=minimal i values=TRUE. |
| csvdel | CSV razdjelnik. Zadani je ; |
| csvenc | CSV okvirna zagrada. Zadana je " |
| csvesc | CSV znak za bijeg. Zadani je \ |
Sljedeće varijable mogu se koristiti globalno, kao i za pojedinačne varijable. Da bi se pozvala pojedinačna varijabla, ona se definira na sljedeći način:
time*:hr=true
Gornji primjer poziva sve varijable koje počinju s time i samu varijablu time. Provjeravaju se sve pravila redom. Time ima prioritet posljednje odgovarajuće pravilo. Pretraživanje vrši se putem regularnog izraza.
| Varijabla | Opis |
|---|---|
| hr | Human Readable. Varijable se, ako je moguće, pretvaraju u podatke koji su čitljivi za ljude. Zadani je TRUE za formate HTML, CSV i Tekst. |
| numdec | Broj decimalnih mjesta. |
| numths | Tisućlomilo razdjelnik. |
| numdot | Decimalni razdjelnik. |
| prefix | Tekst dodati prije varijable. |
| suffix | Tekst dodati nakon varijable. |
Putanje
U donjim poglavljima definirane su sve primjene API-a.