Antcas API

Det Antcas API gör det möjligt att utbyta data mellan flera program.

VARNING: Se till säkerheten vid användning av detta API. Använd endast TLS och använd aldrig porten på en offentligt tillgänglig adress.

Anmärkning: Eftersom API:t måste kontrollera token vid varje anrop kan detta leda till högre systembelastning.

Inställning av en API-port

Under Projektadministration kan en ny API-port läggas till. Beskrivningen hittar du i kapitlet Tilldela port till projektet.

För att ett anrop ska kunna göras måste det autentiseras med hjälp av Token. Skapande av en token förklaras mer ingående i kapitlet Hantera token.

Format och värden

API:t stöder flera indataformat: HTTP-förfrågningar, JSON och XML. Utdata kan vara HTML, text, JSON eller XML. Teckenuppsättningen är alltid UTF-8.

Anmärkning: Ett anrop genom ett element i webbläsaren resulterar i felet 428 (Precondition Required). Detta är XSS-attackskydd, vilket inte kan kringgås. Det förhindrar ett hackerangrepp på Antcas Control.

Vid en POST- eller PUT-förfrågan kan data skrivas i innehållet i motsvarande format. Varje variabel är case-sensitive, det vill säga att skillnad görs mellan versaler och gemener. Returvärdet sker dock alltid i det deklarerade formatet. Utdataformatet kan anges via header eller genom variabeln format. Indataformatet identifieras alltid automatiskt.

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

Följande format stöds i headern och som variabeln format:

Content-Type Variabel Format
application/json json JSON
application/xml xml XML
text/plain text Text
text/csv csv CSV*
(andra) html HTML

*Stöds endast som utdataformat.

Anmärkning: Formaten Text och CSV innehåller UTF-8 BOM. Denna kan inaktiveras med variabeln bom=FALSE.

Om ett värde beskrivs genom flera format har det senare formatet prioritet:

  • HTTP-header (endast utdataformat via Content-Type)
  • GET
  • POST
  • JSON/XML (som POST- eller PUT-innehåll)

Indatavariabler

Följande variabler är globalt definierade.

Variabel Beskrivning
format Format för utdata.
bom BOM i UTF-8-format. Standard är TRUE.
key Läser endast en variabel som deklarerats. Denna metod är ineffektiv, eftersom alla data bearbetas och sedan filtreras. Den bör endast användas för små datamängder.
header Skriv ut header. Standard är TRUE.
compact För samman alla underordnade element. Om ingen boolesk värde deklareras används detta värde för att förena variablerna. Annars används värdet ..
values Returnerar endast värdena och inga variabelnamn. Denna alternativ är endast tillgänglig för HTML, CSV och Text.
minimal Alias för header=FALSE, compact=minimal och values=TRUE.
csvdel CSV-delimitern. Standard är ;
csvenc CSV-inkapslingsparenteser. Standard är "
csvesc CSV-escape-tecken. Standard är \

Följande variabler kan användas globalt, liksom för enskilda variabler. För att komma åt en enskild variabel definieras den som följer:

time*:hr=true

Det ovanstående exemplet talar om alla variabler som börjar med time och time själv. Alla regler kontrolleras i tur och ordning. Så har den sista passande regeln företräde. Sökningen sker med hjälp av reguljära uttryck.

Variabel Beskrivning
hr Läsbar för människor. Variabler omvandlas, om möjligt, till data som är läsbara för människor. Standard är TRUE för formatet HTML, CSV och Text.
numdec Antal decimaler.
numths Tusentalsskiljetecken.
numdot Decimaltecken.
prefix Lägg till text före variabeln.
suffix Lägg till text efter variabeln.

Sökvägar

I de nedre kapitlen definieras alla användningar av API:t.

Undersidor