Selleks et koostada teenuse URL, mida soovid kasutada, pead järgima järgmist struktuuri:

Veebiteenuste rühmitamise baas-URL:

millele tuleb esmalt lisada segment, mis näitab teenust, millele see viitab, ja seejärel valikulised parameetrid, mis määratlevad sinu päringu. Esimene neist peab olema küsimärgi (?) järel, millele järgneb võrdusmärk (=) ja parameetri väärtus. Alates teisest parameetrist, mida soovid lisada, pead kasutama küsimärgi asemel ampersandi (&).

Näide:

Struktuur

Ümbrik

Iga vastus on esitatud struktuuris, mida nimetatakse „envelope“ (ümbrik, ümbris). See tähendab, et igal vastusel on eeldefineeritud struktuur, millega saab suhelda.

{
  "Service": "Teenuse nimi",
  "Version": "Teenuse versioon",
  "TransactionId": "Tehingu tähtnumbriline tunnus",
  "Status": {
    "Code": "Vastuse kood",
    "Value": "Vastuse väärtus"
  },
  "Data": {}
}

Staatus

Võti staatus Seda kasutatakse teenuse vastuse kohta teabe saamiseks. Kui kõik on kulgenud õigesti, näitab vastus atribuudis Kood väärtus 200 või 201. Siiski võib juhtuda, et midagi läheb valesti, mille puhul saadakse järgmine vastus:

{
  "Status": {
    "Code": "401",
    "Value": "Unauthorized"
  }
}

Autentimine

Selle veebisaidi veebiteenuste kasutamiseks tuleb arvestada, et juurdepääsu autentimine on lihtne ning selleks kasutatakse API-kasutajatunnuseid – kasutajanime ja parooli –, mille saad oma MasterBase®-konto kaudu.

Nende kasutamine sõltub teenuste kasutamiseks valitud keelest ning selle eest vastutab teenuse kasutaja.