Aby utworzyć adres URL usługi, z której chcesz skorzystać, należy zastosować następującą strukturę:

Podstawowy adres URL grupujący usługi sieci Web:

do której należy najpierw dodać fragment wskazujący usługę, do której się odnosi, a następnie opcjonalne parametry definiujące dane zapytanie. Pierwszy z nich musi być poprzedzony znakiem zapytania (?), po którym następuje znak równości (=) i wartość parametru. Od drugiego parametru, który chcesz dodać, należy używać znaku ampersand (&) zamiast znaku zapytania.

Przykład:

Struktura

Koperta

Każda odpowiedź jest zawarta w strukturze zwanej „envelope” (kopertą, opakowaniem). Oznacza to, że każda odpowiedź ma z góry określoną strukturę, z którą można wchodzić w interakcję.

{
  "Service": "Nazwa usługi",
  "Version": "Wersja usługi",
  "TransactionId": "Alfanumeryczny identyfikator transakcji",
  "Status": {
    "Code": "Kod odpowiedzi",
    "Value": "Wartość odpowiedzi"
  },
  "Data": {}
}

Status

Klucz status służy do uzyskania informacji o odpowiedzi serwisu. Jeśli wszystko przebiegło prawidłowo, odpowiedź będzie zawierała w atrybucie Kod wartość 200 lub 201. Może się jednak zdarzyć, że coś pójdzie nie tak, a wtedy otrzymana odpowiedź będzie wyglądała mniej więcej tak:

{
  "Status": {
    "Code": "401",
    "Value": "Brak uprawnień"
  }
}

Uwierzytelnianie

Aby korzystać z usług internetowych dostępnych na tej stronie, należy pamiętać, że uwierzytelnianie dostępu ma charakter podstawowy i odbywa się za pomocą danych logowania do API — nazwy użytkownika i hasła — które można uzyskać za pośrednictwem konta MasterBase®.

Wykorzystanie tych funkcji zależy od języka wybranego do korzystania z usług i leży w gestii osoby z nich korzystającej.