API Dokumentācijas Apraksts
Šis dokuments apraksta EEA IS sistēmas RESTful API, kas paredzēts datu apmaiņai izmantojot JSON serializāciju atbilstoši ECMA-404 specifikācijai. API ļauj veikt darbības ar sistēmas objektiem un klasēm. Visi pieprasījumi tiek šifrēti izmantojot TLS šifrēšanu un kvalificētu sertifikātu.
API izmanto CRUD (Create, Read, Update, Delete) principus, izmantojot atbilstošās HTTP metodes:
- POST: Datu izveidošanai
- GET: Datu lasīšanai
- PUT/PATCH: Datu atjaunināšanai
- DELETE: Datu dzēšanai
API Piekļuves Autorizācija
Lai izmantotu API nepieciešams piekļuves talons, ko var iegūt EEA IS liettoāja profilā. Talonu var apsktīties un var uzģenerēt jaunu. Uzģenerējot jaunu talonu vecais talons paliek nederīgs.
Piekļuves piemērs:
curl -X GET -H "Content-Type: application/json" \
-H "Authorization: Bearer t2-Y7VpjJPPqySBG0ZL-_WesHlu1JD4vhT0JBqKUy6s" \
-H "cache-control: no-cache" \
"https://api.example.com/api/v1/test/metodes_nosaukums”
API Versijas un Savietojamība
API tiek atjaunināts, lai atspoguļotu jaunas funkcionalitātes. Jaunas versijas, kas nav savietojamas ar iepriekšējām, tiek norādītas mainot API nosaukumvietu (namespace). Piemēram, /api/v1/project/123/m2.3 pārtop par /api/v2/project/123/m2.3.
Aprēķinu Saskarnes Apraksts
API dokumentācija tiek piegādāta kopā ar katru aprēķinu dzinēja saskarnes versiju. Tā ir pieejama tiešsaistē attiecīgās vides un piegādes versijas kontekstā. Dokumentācija satur informāciju par visām metožu versijām, to parametriem, atbildēm un iespējamajām kļūdām.
Kļūdu apstrāde
API izmanto HTTP protokola statusa laukus kļūdu ziņošanai, piemēram:
200: Veiksmīgs pieprasījums
400: Kļūda pieprasījuma datu struktūrā