Norėdami sukurti paslaugos, kurią ketinate naudoti, URL adresą, turite laikytis šios struktūros:

Žiniatinklio paslaugas grupuojantis bazinis URL:

į kurią pirmiausia reikia įrašyti segmentą, nurodantį paslaugą, į kurią nukreipiama, o po to – pasirinktinius parametrus, apibrėžiančius jūsų užklausą. Pirmasis iš jų turi būti po klaustuko (?), po kurio eina lygybės ženklas (=) ir parametro reikšmė. Nuo antrojo parametro, kurį reikia pridėti, vietoj klaustuko turėsite naudoti simbolį „ampersand“ (&).

Pavyzdys:

Struktūra

Vokas

Kiekvienas atsakymas yra pateiktas struktūroje, vadinamoje „envelope“ (vokas, apvalkalas). Tai reiškia, kad kiekvienas atsakymas turi iš anksto nustatytą struktūrą, su kuria galima sąveikauti.

{
  "Service": "Paslaugos pavadinimas",
  "Version": "Paslaugos versija",
  "TransactionId": "Alfanumerinis sandorio identifikatorius",
  "Status": {
    "Code": "Atsakymo kodas",
    "Value": "Atsakymo vertė"
  },
  "Data": {}
}

Statusas

Svarbiausia statusas naudojama informacijai apie paslaugos atsakymą gauti. Jei viskas vyko kaip numatyta, atsakyme bus nurodyta Kodas reikšmė 200 arba 201. Tačiau gali nutikti, kad kažkas nepavyks, ir tokiu atveju gausite tokį atsakymą:

{
  "Status": {
    "Code": "401",
    "Value": "Neleidžiama"
  }
}

Autentiškumo nustatymas

Norint naudotis šioje svetainėje teikiamomis žiniatinklio paslaugomis, reikia atsižvelgti į tai, kad prisijungimo autentiškumo patvirtinimas yra paprastas, o tam naudojami API prisijungimo duomenys – vartotojo vardas ir slaptažodis – kuriuos galima gauti per savo „MasterBase®“ paskyrą.

Jų naudojimas priklausys nuo kalbos, pasirinktos paslaugoms naudotis, ir už tai atsako asmuo, kuris jomis naudojasi.