Antcas API
Det Antcas API gør det muligt at udveksle data mellem flere applikationer.
| ADVARSEL: Vær opmærksom på sikkerheden ved brug af denne API. Brug kun TLS og benyt aldrig porten på en offentlig tilgængelig adresse. |
Note: Da API'et skal kontrollere tokenet ved hver opkald, kan dette resultere i en højere systembelastning.
Opsætning af en API-port
Under Projektadministration kan der tilføjes en ny
API-port. Beskrivelsen findes i kapitlet Tilknyt port til projektet.
For at en anmodning kan oprettes, skal den autentificeres ved hjælp af Token. Oprettelse af et token forklares nærmere i kapitlet Administrer tokens.
Formater og værdier
API'et understøtter flere indtastningsformater: HTTP-Queries, JSON og XML. Output kan være HTML, tekst, JSON eller XML. Tegnkodingen er altid UTF-8.
Note: Et opkald fra et element i browseren resulterer i fejlen 428 (Precondition Required). Dette er XSS-angrebssikringen, som ikke kan omgås. Det forhindrer et hackerangreb på Antcas Control.
Ved en POST- eller PUT-anmodning kan data skrives via indholdet i det relevante format. Hver variabel er case-sensitive, hvilket betyder at der skelnes mellem store og små bogstaver. Outputtet gives dog altid i det angivne format. Outputformatet kan specificeres via header eller ved hjælp af variablen format. Inputformatet genkendes altid automatisk.
GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json
Følgende formater understø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 |
*Kun understøttet som outputformat.
Note: Formaterne Tekst og CSV indeholder UTF-8 BOM. Denne kan deaktiveres ved hjælp af variablen bom=FALSE.
Hvis en værdi specificeres via flere formater, har det sidste format forrang:
- HTTP-Header (kun outputformat via Content-Type)
- GET
- POST
- JSON/XML (som POST- eller PUT-indhold)
Input-variabler
Følgende variabler er globalt defineret.
| Variabel | Beskrivelse |
|---|---|
| format | Format for output. |
| bom | BOM i UTF-8-format. Standard er TRUE. |
| key | Læser kun en variabel, der er deklareret. Denne metode er ineffektiv, da alle data forberedes og først derefter filtreres. Den bør kun bruges til små datamængder. |
| header | Output header. Standard er TRUE. |
| compact | Fletter alle underelementer sammen. Hvis ingen boolesk værdi er deklareret, bruges denne værdi til at kombinere variablerne. Ellers bruges værdien .. |
| values | Returnerer kun værdierne og ikke variabelnavne. Denne mulighed er kun tilgængelig for HTML, CSV og tekst. |
| minimal | Alias for header=FALSE, compact=minimal og values=TRUE. |
| csvdel | CSV-adskiller. Standard er ; |
| csvenc | CSV-indeslutningsparenteser. Standard er " |
| csvesc | CSV-escape-tegn. Standard er \ |
Følgende variabler kan bruges globalt, såvel som for enkeltvariabler. For at henvise til en enkeltvariabel defineres den som følger:
time*:hr=true
Det ovenstående eksempel henviser til alle variabler, der starter med time og time selv. Alle regler kontrolleres i rækkefølge. Den sidste passende regel har forrang. Søgningen foregår ved hjælp af regulære udtryk.
| Variabel | Beskrivelse |
|---|---|
| hr | Human Readable. Variabler konverteres, hvis muligt, til menneskelæselige data. Standard er TRUE for formaterne HTML, CSV og tekst. |
| numdec | Antal decimaler. |
| numths | Tusindadskiller. |
| numdot | Decimaltegn. |
| prefix | Tilføj tekst før variabel. |
| suffix | Tilføj tekst efter variabel. |
Stier
I de følgende kapitler er alle anvendelser af API'et defineret.