API Antcas
API Antcas lejon që të shkëmbehen të dhëna ndërmjet shumë aplikacioneve.
| PARALAM: Ju lutemi të keni kujdes për sigurinë gjatë përdorimit të këtij API. Përfshini vetëm TLS dhe mos përdorni asnjëherë portin në një adresë publike. |
Shënim: Sepse API duhet të verifikojë tokenin në çdo thirrje, kjo mund të shkaktojë një ngarkesë më të lartë të sistemit.
Rregullimi i një porti API
Në Menaxheri i Projekteve mund të shtohet një port i ri
API. Përshkrimi gjendet në kapitulli Porti i caktuar projektit.
Për të krijuar një kërkesë, duhet të autentifikohet përmes Token. Kriimi i një tokeni shpjegohen më në detaje në kapitulli Menaxhimi i Tokenit.
Formate dhe Vlerat
API mbështet disa formate hyrëse: HTTP-Queries, JSON dhe XML. Shfaqja mund të bëhet në HTML, Teks, JSON ose XML. Kodimi i karaktereve është gjithmonë UTF-8.
Shënim: Një thirrje nga një element në shfletues do të rezultojë në gabimin 428 (Precondition Required). Kjo është mbrojtja kundër sulmeve XSS, e cila nuk mund të anulohet. Ajo parandalon një sulm hakimi ndaj Antcas Control.
Në një kërkesë POST ose PUT, të dhënat mund të shkruhen përmes përmbajtjes në formatin e përkatësishëm. Çdo variablë është Case Sensitive, që do të thotë se dallon midis shkronjave të mëdha dhe të vogla. Kthimi bëhet gjithmonë në formatin e deklaruar. Formati i shfaqjes mund të përcaktohet përmes Header ose përmes variablës format. Formati i hyrjes identifikohet gjithmonë automatikisht.
GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json
Formatet e mëposhtme mbështeten në Header dhe si variablë format:
| Content-Type | Variabla | Format |
|---|---|---|
| application/json | json | JSON |
| application/xml | xml | XML |
| text/plain | text | Teks |
| text/csv | csv | CSV* |
| (të tjera) | html | HTML |
*Mbështet vetëm si format shfaqje.
Shënim: Formatet Teks dhe CSV përmbajnë UTF-8 BOM. Kjo mund të çaktivizohet përmes variablës bom=FALSE.
Nëse një vlerë përshkruet përmes shumë formatesh, formati më i fundit ka prioritet:
- HTTP-Header (vetëm format shfaqje përmes Content-Type)
- GET
- POST
- JSON/XML (si POST- ose PUT-Content)
Variablat e Hyrjes
Variablat e mëposhtme janë të përcaktuara globalisht.
| Variabla | Përshkrimi |
|---|---|
| format | Formati i shfaqjes. |
| bom | BOM në format UTF-8. Vlera e parazgjedhur është TRUE. |
| key | Lexon vetëm një variablë të deklaruar. Kjo metodë është ineffektive, sepse të gjitha të dhënat përgatiten dhe pastaj filtrohen. Duhet të përdoret vetëm me sasi të vogla të të dhënave. |
| header | Shfaq Header. Vlera e parazgjedhur është TRUE. |
| compact | Bashkon të gjitha elementet nën-elementesh. Nëse nuk deklarohet një vlerë booleane, kjo vlerë përdoret për të bashkuar variablat. Një tjetërherë përdoret vlera .. |
| values | Kthen vetëm vlerat dhe jo emrat e variablave. Kjo opsion është i disponueshëm vetëm për HTML, CSV dhe Teks. |
| minimal | Alias për header=FALSE, compact=minimal dhe values=TRUE. |
| csvdel | CSV-Delimiter. Vlera e parazgjedhur është ; |
| csvenc | CSV-Enclosure-Klammern. Vlera e parazgjedhur është " |
| csvesc | CSV-Escape-Zeichen. Vlera e parazgjedhur është \ |
Variablat e mëposhtme mund të përdoren globalisht, si dhe për variabla individuale. Për të adresuar një variablë individuale, ajo përcaktohet si më poshtë:
time*:hr=true
Shembulli i sipërme adreson të gjitha variablat që fillojnë me time dhe time vetë. Kontrollohen të gjitha rregullat në radhë. Kështu, reguła e fundit e përshtatshme ka prioritet. Kërkohet përmes shprehjes së përgjithshme.
| Variabla | Përshkrimi |
|---|---|
| hr | Human Readable. Variablat konvertohen, nëse është e mundur, në të dhëna të lexueshme nga njerëzit. Vlera e parazgjedhur është TRUE për formatet HTML, CSV dhe Teks. |
| numdec | Numri i vendeve pas presjes. |
| numths | Trenuesi i mijëra. |
| numdot | Presja e numrave. |
| prefix | Shtoni tekst para variablës. |
| suffix | Shtoni tekst pas variablës. |
Rrugët
Në kapitujt e mëposhtëm janë të përcaktuara të gjitha aplikimet e API-së.