Sammud Integriti XML REST API registreerimiseks

Registreerimine

Integriti XML REST API registreerimiseks mine siia lingile ning täida vorm

https://license.innerrange.com/Integrations/Create

Täidetavate väljade kirjeldused

  • Proposed Integration Name: vali siia mõistlik ning tähenduslik nimi oma arendusele
  • Integration Purpose: kirjelda, mida sa arendad
  • Integration will be re-used on multiple sites: tee siia linnuke, kui arendad Integriti süsteemile nii, et seda hakatakse kasutama mitmel eraldi objektil (erinevad Integriti serverid).
  • Regional Distributor: vali siia kindlasti Inner Range Europe
  • Contact Details: siia palun sisesta lõppkliendi (või kui oled ise arendajana lõppklient) andmed
  • I require an Integriti Demo Key for development: tee siia linnuke, kui alles hakkad arendama ning konkreetset Integriti serverit pole veel. Sedasi genereeritakse sulle demo Product Key, millega saad installeerida endale Integriti tarkvara, alustada arendamisega ning testimisega.
  • Automatically unlock integration on an existing product key: kui sul on teada konkreetne Integriti installatsioon, millele sa hakkad arendama/integreerima, siis sisesta siia olemasoleva registreeritud Integriti tarkvara “Product Key”. Selle saad kliendi käest ja/või kliendi Integriti tarkvarast: Administration -> License Manager -> väli Product Key
  • Accept: kinnita linnukesega, et kõik väljad on korrektselt täidetud.
  • Submit Application: lõpeta ning saada registreerimise avaldus.

Tulemus

Kui registreerimine on tehtud, siis 3-5 tööpäeva jooksul Inner Range vaatab sinu täidetud andmed üle ning genereerib sinu antud Product Key-le litsentsi, mis aktiveerib selle Product Key-ga registreeritud tarkvaras võimaluse kasutada XML REST API.

Lisaks litsentsile, jagatakse sulle ka API võti (API Key), mis on vajalik XML REST API päringute tegemiseks. API võti peab sisalduma päringu päises (Header) väärtusena API-KEY:sinuapivõti.

NB! Kui samade andmetega klient teeb lisa integratsioone tulevikus, siis litsents tuleb uus, kuid API võti jääb samaks.

Integriti XML REST API teenuse käivitamine

Kui sul on olemas XML REST API integratsiooni litsents, see on lisatud Integriti süsteemi ning oled saanud ka API võtme, siis tuleb Integritis seadistada Integriti server.

  • Administration -> Communication Handler -> Add New

Väljad

  • Port number: vali port oma Integriti serveri masinas, mille pihta päringud tehakse
  • Path prefix (valikuline): vali endale sobiv url prefix
  • Url to documentation: mine sellele aadressile. Sellel lingil asub XML REST API documentatsioon koos koos abistavate näidetega. Samuti on seal võimalik teha lihtsamaid näidis päringuid Integriti serveri pihta.
  • Enable User Management: tee siia linnuke, kui sinu arendus seisneb peamiselt kasutajate haldamises.
  • Enable Status and Control: tee siia linnuke, kui sinu arendus seisneb erinevate väärtuste (uksed, väljundid, sisendid jne) juhtimises ning olekute monitoorimises
  • Enable Virtual Card Badge: tee siia linnuke, kui sinu arendus üritab teha virtuaalseid läbipääsukaardite näitamist. Näiteks emuleerite kaardiga uksest läbimist.
  • Enable Review I/O: tee siia linnuke, kui sinu arendus vajab Integriti Review sündmusi.
  • Session Expiry: vali siia aeg, millal sinu sessioon aegub
  • Use Security: tee siia linnuke, kui päringute tegemine vajab autoriseerimist
  • Security Type: vali Basic (Basic Auth) või HTTPS (HTTPS autoriseerimist) turvalisust. NB! HTTPS vajab selleks sertifikaati ning selle eest peab hoolitsema Integriti serveri administraator vms.
  • Operator: vali siia Integriti Operator, kes võib teha päringuid Integriti serveri pihta.
  • Salvestas sätted

Kui oled seadistused teinud ning salvestanud, siis näed selle olekut Communication Handler nimekirjas

Integriti XML REST API on nüüd aktiveeritud, seadistatud ning valmis kasutamiseks.