Antcas API
Det Antcas API gjør det mulig å utveksle data mellom flere applikasjoner.
| ADVARSEL: Vær oppmerksom på sikkerheten ved bruk av denne API. Bruk bare TLS og bruk aldri porten på en offentlig tilgjengelig adresse. |
Merk: Siden API må sjekke tokenet ved hver oppringning, kan dette føre til høyere systembelastning.
Oppsett av en API-port
Under Prosjektadministrasjon kan det legges til en ny
API-port. Beskrivelsen finner du i kapitlet Tilordne port til prosjektet.
For å kunne lage en forespørsel, må denne autentiseres ved hjelp av Token. Oppretting av et token forklares nærmere i kapitlet Administrere Token.
Formater og verdier
API støtter flere inputformater: HTTP-Queries, JSON og XML. Output kan være HTML, tekst, JSON eller XML. Tegnkodingen er alltid UTF-8.
Merk: En oppringning fra et element i nettleseren resulterer i feilen 428 (Precondition Required). Dette er XSS-angrepsbeskyttelsen, som ikke kan omgås. Dette forhindrer et hackerangrep på Antcas Control.
Ved en POST- eller PUT-forespørsel kan data skrives over innholdet i det tilsvarende formatet. Hver variabel er case-sensitive, hvilket betyr at det skilles mellom store og små bokstaver. Returen skjer imidlertid alltid i det deklarerte formatet. Utdataformatet kan beskrives via header eller gjennom variablen format. Inputformatet blir alltid automatisk oppdaget.
GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json
Følgende formater støttes i header og som variabel format:
| Content-Type | Variabel | Format |
|---|---|---|
| application/json | json | JSON |
| application/xml | xml | XML |
| text/plain | text | Tekst |
| text/csv | csv | CSV* |
| (andre) | html | HTML |
*Støttes bare som utdataformat.
Merk: Formatene Tekst og CSV inneholder UTF-8 BOM. Denne kan deaktiveres ved hjelp av variabel bom=FALSE.
Hvis en verdi beskrives gjennom flere formater, har det siste formatet prioritet:
- HTTP-Header (bare utdataformat via Content-Type)
- GET
- POST
- JSON/XML (som POST- eller PUT-innhold)
Input-variabler
Følgende variabler er globalt definerte.
| Variabel | Beskrivelse |
|---|---|
| format | Format for utdata. |
| bom | BOM i UTF-8-format. Standard er TRUE. |
| key | Leser bare en variabel som er deklarert. Denne metoden er ineffektiv, siden alle data må forberedes og først deretter filtreres. Den bør bare brukes med små datamengder. |
| header | Skriv ut header. Standard er TRUE. |
| compact | Fører alle subelementer sammen. Hvis ingen boolesk verdi er deklarert, brukes denne verdien til å slå sammen variablene. Ellers brukes verdien .. |
| values | Returnerer bare verdiene og ikke variabelnavnene. Denne valget er bare tilgjengelig for HTML, CSV og tekst. |
| minimal | Alias for header=FALSE, compact=minimal og values=TRUE. |
| csvdel | CSV-delimiter. Standard er ; |
| csvenc | CSV-inneslutningsparenteser. Standard er " |
| csvesc | CSV-escape-tegn. Standard er \ |
Følgende variabler kan brukes globalt, samt for enkeltvariabler. For å hente en enkeltvariabel, defineres den som følger:
time*:hr=true
Eksempelet ovenfor henter alle variabler som starter med time og time selv. Alle regler sjekkes i rekkefølge. Slik har den siste passende regelen forrang. Søk skjer ved hjelp av regulære uttrykk.
| Variabel | Beskrivelse |
|---|---|
| hr | Human Readable. Variabler konverteres, hvis mulig, til menneskelige lesbare data. Standard er TRUE for formatene HTML, CSV og tekst. |
| numdec | Antall desimaler. |
| numths | Tusen-skilletegn. |
| numdot | Desimal-skilletegn. |
| prefix | Legg til tekst før variabelen. |
| suffix | Legg til tekst etter variabelen. |
Stier
I de følgende kapitlene er alle applikasjoner av API definert.