API kasutamine

API kasutamise eesmärk on võimaldada erinevatel tarkvaradel omavahel suhelda ja andmeid vahetada ilma, et peaks teadma teise süsteemi sisemist toimimist. Maakeeli - API on nagu “tõlk” või “teenindaja”, kes võtab ühe programmi päringu vastu, viib selle teise süsteemi juurde ja toob vastuse tagasi.

API võtme loomine

Tokeni (API võti) loomine on ainult peakasutaja õigus. Võtme loomisel arvesta, et see on nähtav vaid loomisprotsessi käigus. Kui võti on nähtav, siis siis salvesta see endale ohutusse kohta. Võtme kaotamisel kustuta see admin paneelist ja loo uuesti.

API võtme loomiseks:

1. Kliki päises HALDUS
2. Vasakul Kasutajakontod
3. API võtmed
4. Kliki nupul “Lisa API võti”
5. Nimi - anna võtmele nimetus soovitavalt rakenduse või integratsiooni järgi näiteks „Tööaja tabelid“, „Standard Books“ vms.
6. Kasutaja - Määra võtme kasutaja. Kasutaja valikuga määratletakse API päringute õigused. Kasutajaga saab piirata API poolt kättesaadavate andmete hulka objektide ja andmetabelite lõikes. Teisisõnu, API päringutega saab siusuliselt kätte sama palju infot, nagu on nähtav sellesama kasutajatunnusega visuaalselt veebirakenduses.
7. Aegumiskuupäev - Aegumiskuupäeva soovitame määrata. Kui jätad määramata, on kehtivusaeg igavene.
8. Kliki “Salvesta”
   

Järgnevalt genereeritakse API võti ja saad selle endale kopeerida. NB! Hoiusta seda turvalises kohas.

API kirjeldus on leitav siit: https://api2.metrotec.ee/docs