A felhasználni kívánt szolgáltatás URL-jének összeállításához a következő szerkezetet kell követned:

A webszolgáltatásokat csoportosító bázis-URL:

Ehhez először hozzá kell adnod azt a szegmenst, amely megadja a célszolgáltatást, majd az adott lekérdezést meghatározó opcionális paramétereket. Az elsőnek egy kérdőjel (?) után kell következnie, amelyet egy egyenlőségjel (=) és a paraméter értéke követ. A második paramétertől kezdve, amelyet hozzá kell adnia, a kérdőjel helyett az ampersand (&) jelet kell használnia.

Példa:

Szerkezet

A boríték

Minden válasz egy úgynevezett „envelope” (boríték, csomagolás) nevű struktúrában található. Ez azt jelenti, hogy minden válasz rendelkezik egy előre meghatározott struktúrával, amellyel interakcióba lehet lépni.

{
  "Service": "Szolgáltatás neve",
  "Version": "Szolgáltatás verziója",
  "TransactionId": "Tranzakció alfanumerikus azonosítója",
  "Status": {
    "Code": "Válasz kódja",
    "Value": "Válasz értéke"
  },
  "Data": {}
}

Állapot

A kulcs státusz a szolgáltatás válaszáról szóló információk lekérésére szolgál. Ha minden rendben lezajlott, a válasz az attribútumban jelzi Kód a 200 vagy 201 érték. Előfordulhat azonban, hogy valami nem működik megfelelően, amely esetben a kapott válasz a következő lesz:

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

Hitelesítés

A webhelyen elérhető webszolgáltatások igénybevételéhez figyelembe kell venni, hogy a belépéshez szükséges hitelesítés alapszintű, és ehhez az API-hitelesítő adatokat – felhasználónév és jelszó – használják, amelyeket a MasterBase®-fiókodon keresztül szerezhetsz be.

Ezek használata a szolgáltatások igénybevételéhez választott nyelvtől függ, és az igénybevevő felelőssége.