Ak chcete vytvoriť URL služby, ktorú chcete využívať, musíte ju zostaviť podľa nasledujúcej štruktúry:

Základná adresa URL zoskupujúca webové služby:

K nemu musíš najprv pridať segment, ktorý označuje službu, na ktorú sa odkazuje, a následne voliteľné parametre, ktoré definujú daný dotaz. Prvý z nich musí byť uvedený za znakom otáznika (?), za ktorým nasleduje znak rovná sa (=) a hodnota parametra. Od druhého parametra, ktorý potrebujete pridať, musíte namiesto znaku otáznika použiť znak ampersand (&).

Príklad:

Štruktúra

Obálka

Každá odpoveď je obsiahnutá v štruktúre nazývanej „envelope“ (obálka, obal). To znamená, že každá odpoveď má vopred definovanú štruktúru, s ktorou je možné interagovať.

{
  "Service": "Názov služby",
  "Version": "Verzia služby",
  "TransactionId": "Alfanumerický identifikátor transakcie",
  "Status": {
    "Code": "Kód odpovede",
    "Value": "Hodnota odpovede"
  },
  "Data": {}
}

Stav

Kľúč stav slúži na získanie informácií o odpovedi služby. Ak všetko prebehlo správne, odpoveď bude v atribúte uvádzať Kód hodnota 200 alebo 201. Môže sa však stať, že niečo zlyhá, a v takom prípade bude odpoveď vyzerať takto:

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

Overovanie

Pri využívaní webových služieb dostupných na tejto stránke je potrebné zohľadniť, že overovanie prístupu je základné a na tento účel sa používajú prihlasovacie údaje API – používateľské meno a heslo –, ktoré získate prostredníctvom vášho účtu MasterBase®.

Ich použitie bude závisieť od jazyka, ktorý si zvolíte na využívanie služieb, a zodpovednosť za to nesie ten, kto tieto služby využíva.