Uuendatud 11. detsember 2023

API päringute turvalisus ja kasutajaõigused

API kasutab isiku kasutajagrupi õiguseid, mis Standard Booksis seadistatud. API päringute jaoks loodud Isikul peab olema lubatud registrile (näiteks: Arved, Tellimused, Kontaktid vm) Täielik või Vaatamise õigus ja moodul, mille all register programmis asub. Andmete nägemise õiguseid saab kontrollida, kui selle isiku nimega siseneda Standard Books klientprogrammi. Nendes registrites, mida kasutaja näeb, nende kohta saab ka vormistada päringuid. Kasutajaõiguste seadistamisest loe täpsemalt SIIT

Tingimused:

1. On registreid, mis vaikimisi ei ole programmis kasutajatele nähtavad, nende puhul on vajalik erilahendus (HAL). Sellised registrid on näiteks RHistVc või MailVc.
2. Kasutaja autentimiseks tuleb kasutada meetodi: OAuth2 (loe lisa allpool)
3. “api” kataloogi on võimalik turvata programmis moodulis “Veebipood ja CMS” seadistuses “Ligipääs funktsioonidele veebist“.
   • Vaikimisi ligipääs HAL funktsioonidele on välja lülitatud.
   • Vaikimisi ligipääs “api” kataloogile nõuab login-i.
   • Kõikidele teistele registritele on ligipääs Public.
4. Üldises moodulis peab olema loodud kasutajanimi Isikute registrisse. Sisselogimiseks peab kasutama valideeritud e-maili ja sellega seotud parooli. Uue isiku loomise ja valideerimise juhendi leiad SIIT
5. Isik, kelle nimega päringuid teostatakse, peab Booksis olema seotud kasutajagrupiga, millele on lisatud eraldi reaga õigus:
   Toiming /  Rest API / Täis
6. Kui kasutajale on programmis kasutajaõigustega piiratud mingite üksikute andmeväljade nägemine mõne kaardi peal (näiteks ostuhind), siis API kaudu on võimalik neid andmeid siiski pärida.
   Selleks, et mingi registri poole päringuga pöörduda saaks, peab kasutajal olema vähemalt Vaatamise õigus Kasutajagruppide seadistuses.
7. HTTPS on toetatud, kui on olemas sertifikaadid. Soovitame seda kasutada HTTP asemel. Excellenti pilveteenuse kasutajatele seadistatakse sertifikaadid Excellenti administraatori poolt.Võimalik on piirata päringuid ainult kindlalt IP aadressilt. Selleks tuleb teha seadistus moodulis “Veebipood ja CMS” > seadistus “Ligipääs funktsioonidele veebist” > lahter “Lubatud IP-d“.