Leia vastused
API päringute turvalisus ja kasutajaõigusedUuendatud 12. jaanuar 2023
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:
- 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.
- Kasutaja autentimiseks tuleb kasutada meetodi: OAuth2 (loe lisa allpool)
- “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. - Üldises moodulis peab olema loodud kasutajanimi Isikute registrisse. Lisaks tuleb kasutajale seadistada parool. Soovitame sisselogimiseks kasutada valideeritud e-maili ja sellega seotud parooli. Uue isiku loomise ja valideerimise juhendi leiad SIIT
- Isik, kelle nimega päringuid teostatakse, peab Booksis olema seotud kasutajagrupiga, millele on lisatud eraldi reaga õigus:
Toiming / Rest API / Täis - 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. - 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“.
OAuth audentifitseerimine
Selleks, et seadistada OAuth kasutamine Rest API’ga, tuleb läbida järgnevad sammud:
• Samm 1: Seadistage Developer Credentials MyStandard’i keskkonnas enda StandardID kasutajale.
Seda on võimalik seadistada kui valite MyStandard keskkonnas: More > Developer Credentials ja vajutate Add New
• Samm 2: Täitke väljad järgnevalt:
Application Name – Nimetus
Allowed Redirects – Sisestage väljale URL, kuhu kasutaja suunatakse peale StandardIDga sisselogimist. (Callback URL)
• Kolmanda osapoole tarkvaras, mida kasutatakse OAuth’i realiseerimiseks, tuleb määrata URL, kuhu kasutaja suunatakse peale edukat autentifitseerimist. Selleks tuleb määrata järgnev URL:
https://standard-id.hansaworld.com/oauth-authorize
Kasutades GET parameetreid:
Client_id – Client ID MyStandard keskkonnas olevas seadistuses Developer Credentials
Redirect_uri – Määratud kolmandaosapoole tarkvara URL, mis tegeleb callback päringuga StandardID poolt peale sisse logimist.
Access_type – Peab olema määratud „offline“
Response_type – Peab olema määratud „code“
Kui on soov testida OAuth toimimist, siis selle kohta on võimalik lugeda järgnevalt lingilt:
(SOAP, sertifikaat)