Antcas API

Antcas API mahdollistaa tietojen vaihtamisen useiden sovellusten välillä.

VAROITUS: Kiinnitä huomiota turvallisuuteen käytettäessä tätä API:ta. Käytä vain TLS ja älä koskaan käytä porttia julkisessa osoitteessa.

Huomautus: Koska API tarkistaa tokenin joka kerta kutsuttaessa, tämä voi aiheuttaa suurempaa järjestelmän kuormitusta.

API-portin asettaminen

Uusi API-portti voidaan lisätä projektinhallinnassa. Ohjeet löytyvät luvusta Portin liittäminen projektiin.

Jotta pyyntö voidaan luoda, se on authentifioitava tokenin avulla. Tokenin luominen selitetään tarkemmin luvussa Tokenien hallinta.

Formaatit ja arvot

API tukee useita syöteformaatteja: HTTP-kyselyt, JSON ja XML. Tuotos voi olla HTML-, teksti-, JSON- tai XML-muodossa. Merkistökoodaus on aina UTF-8.

Huomautus: Elementin kutsuminen selainta käyttäen aiheuttaa virheen 428 (Precondition Required). Tämä on XSS-hyökkäyssuojaus, jota ei voi ohittaa. Se estää hyökkäyksen Antcas Controliin.

POST- tai PUT-pyynnössä tiedot voidaan kirjoittaa sisällön avulla vastaavassa muodossa. Jokainen muuttuja on case-sensitive, mikä tarkoittaa, että isoista ja pienistä kirjaimista tehdään ero. Palautus tapahtuu kuitenkin aina määritellyssä muodossa. Tuotemuoto voidaan kuvata päätteen tai muuttujan format avulla. Syötemuoto tunnistetaan aina automaattisesti.

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

Seuraavat muodot tuetaan päätteessä ja muuttujassa format:

Content-Type Muuttuja Muoto
application/json json JSON
application/xml xml XML
text/plain text Teksti
text/csv csv CSV*
(muut) html HTML

*Tuetaan vain tuotemuodossa.

Huomautus: Teksti- ja CSV-muodot sisältävät UTF-8 BOM:n. Tämä voidaan poistaa muuttujalla bom=FALSE.

Jos arvo määritellään useissa muodoissa, viimeisellä muodolla on prioriteetti:

  • HTTP-päätteet (vain tuotemuoto Content-Typen kautta)
  • GET
  • POST
  • JSON/XML (POST- tai PUT-sisältönä)

Syötemuuttujat

Seuraavat muuttujat ovat globaalisti määriteltyjä.

Muuttuja Kuvaus
format Tuotomuoto.
bom BOM UTF-8-muodossa. Oletusarvo on TRUE.
key Lue vain yksi muuttuja, joka on määritelty. Tämä menetelmä on epätehokas, koska kaikki tiedot valmistellaan ja suodatetaan vasta sen jälkeen. Sitä tulisi käyttää vain pienillä tietomäärillä.
header Tulosta päätteet. Oletusarvo on TRUE.
compact Yhdistää kaikki alielementit yhteen. Jos ei ole määritelty booleaanista arvoa, käytetään tätä arvoa muuttujien yhdistämiseksi. Muuten käytetään arvoa ..
values Palauttaa vain arvot, ei muuttujanimiä. Tämä vaihtoehto on saatavilla vain HTML-, CSV- ja tekstimuodoissa.
minimal Alias header=FALSE, compact=minimal ja values=TRUE.
csvdel CSV-erotin. Oletusarvo on ;
csvenc CSV-sulkemismerkit. Oletusarvo on "
csvesc CSV-pakoitusmerkit. Oletusarvo on \

Seuraavat muuttujat voidaan käyttää globaalisti sekä yksittäisten muuttujien osalta. Yksittäistä muuttujaa kutsutaan seuraavasti:

time*:hr=true

Yllä oleva esimerkki kutsuu kaikki muuttujat, jotka alkavat time ja time itse. Kaikki säännöt tarkistetaan peräkkäin. Siten viimeinen sopiva sääntö on prioriteetissa. Etsintä tapahtuu säännöllisellä ilmaisuella.

Muuttuja Kuvaus
hr Human Readable. Muuttujat muutetaan, jos mahdollista, ihmiselle luettaviksi tiedoiksi. Oletusarvo on TRUE HTML-, CSV- ja tekstimuodoille.
numdec Desimaalipaikkojen määrä.
numths Tuhansien erotinmerkki.
numdot Desimaalierotinmerkki.
prefix Lisätään teksti muuttujan eteen.
suffix Lisätään teksti muuttujan perään.

Polut

Alla olevissa luvuissa on määritelty kaikki API:n sovellukset.

Alaisivut