Antcas API

Het Antcas API maakt het mogelijk om gegevens uit te wisselen tussen verschillende applicaties.

WAARSCHUWING: Let op de beveiliging bij het gebruik van deze API. Gebruik alleen TLS en gebruik nooit het poortnummer op een openbaar toegankelijk adres.

Opmerking: Omdat het API bij elke oproep het token moet controleren, kan dit leiden tot een hogere systeembelasting.

API-Poort Instellen

Onder de Projectbeheer kan er een nieuwe API-Poort worden toegevoegd. De beschrijving vindt u in het hoofdstuk Poort Toekennen Aan Project.

Om een verzoek te kunnen maken, moet dit worden geauthenticeerd met behulp van Token. Het maken van een token wordt in het hoofdstuk Token Beheren nader uitgelegd.

Formaten En Waarden

Het API ondersteunt meerdere invoegformaten: HTTP-Queries, JSON en XML. De uitvoer kan bestaan uit HTML, Tekst, JSON of XML. De tekencodering is altijd UTF-8.

Opmerking: Een oproep door een element in de browser resulteert in fout 428 (Precondition Required). Dit is de XSS-aanvalbescherming, deze kan niet worden omzeild. Dit voorkomt een hackaanval op Antcas Control.

Bij een POST- of PUT-verzoek kunnen de gegevens via de inhoud in het overeenkomstige formaat worden geschreven. Elke variabele is daarbij hoofdlettergevoelig, dit betekent dat er onderscheid wordt gemaakt tussen hoofd- en kleine letters. De teruggave vindt echter altijd plaats in het aangegeven formaat. Het uitvoerformaat kan via de header of via de variabele format worden beschreven. Het invoerformaat wordt altijd automatisch herkend.

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

De volgende formaten worden in de header en als variabele format ondersteund:

Content-Type Variabele Formaat
application/json json JSON
application/xml xml XML
text/plain text Tekst
text/csv csv CSV*
(andere) html HTML

*Wordt alleen als uitvoerformaat ondersteund.

Opmerking: De formaten Tekst en CSV bevatten de UTF-8 BOM. Deze kan worden gedeactiveerd met behulp van variabele bom=FALSE.

Als een waarde wordt beschreven via meerdere formaten, heeft het laatste formaat voorrang:

  • HTTP-Header (alleen uitvoerformaat via Content-Type)
  • GET
  • POST
  • JSON/XML (als POST- of PUT-inhoud)

Invoer-Variabelen

De volgende variabelen zijn globaal gedefinieerd.

Variabele Beschrijving
format Formaat van de uitvoer.
bom BOM in UTF-8-formaat. Standaard is TRUE.
key Leest alleen een variabele die is gedefinieerd. Deze methode is inefficiënt, omdat alle gegevens worden opgemaakt en vervolgens gefilterd. Het moet alleen worden gebruikt bij kleine hoeveelheden gegevens.
header Header weergeven. Standaard is TRUE.
compact Voegt alle subelementen samen. Als geen booleaanse waarde is gedefinieerd, wordt deze waarde gebruikt om de variabelen samen te voegen. Anders wordt de waarde . gebruikt.
values Geeft alleen de waarden en geen variabelenamen terug. Deze optie is alleen beschikbaar voor HTML, CSV en Tekst.
minimal Alias voor header=FALSE, compact=minimal en values=TRUE.
csvdel CSV-Scheidingsteken. Standaard is ;
csvenc CSV-Haakjes. Standaard is "
csvesc CSV-Escapeteken. Standaard is \

De volgende variabelen kunnen globaal, evenals voor individuele variabelen worden gebruikt. Om een enkele variabele aan te spreken, wordt deze als volgt gedefinieerd:

time*:hr=true

Het bovenstaande voorbeeld spreekt alle variabelen aan die beginnen met time en time zelf. Alle regels worden in volgorde gecontroleerd. Zo heeft de laatste passende regel voorrang. Gezocht wordt met behulp van reguliere expressies.

Variabele Beschrijving
hr Mens Leesbaar. Variabelen worden, indien mogelijk, omgezet in voor mensen leesbare gegevens. Standaard is TRUE voor het formaat HTML, CSV en Tekst.
numdec Aantal decimalen.
numths Duizendtalscheidingsteken.
numdot Decimale scheidingsteken.
prefix Tekst voor variabele toevoegen.
suffix Tekst na variabele toevoegen.

Paden

In de onderstaande hoofdstukken zijn alle toepassingen van het API gedefinieerd.

Ondergeschikte Paginan