Чтобы составить URL-адрес службы, которую вы хотите использовать, необходимо придерживаться следующей структуры:

Базовый URL, объединяющий веб-сервисы:

к которому сначала необходимо добавить сегмент, указывающий на нужную службу, а затем дополнительные параметры, определяющие конкретный запрос. Первый из них должен предваряться знаком вопросительного знака (?), за которым следует знак равенства (=) и значение параметра. Начиная со второго параметра, который необходимо добавить, вместо вопросительного знака следует использовать знак амперсанд (&).

Пример:

Структура

Конверт

Каждый ответ заключён в структуру, называемую «envelope» (конверт, оболочка). Это означает, что каждый ответ имеет заранее определённую структуру, с которой можно взаимодействовать.

{
  "Service": "Название службы",
  "Version": "Версия службы",
  "TransactionId": "Буквенно-цифровой идентификатор транзакции",
  "Status": {
    "Code": "Код ответа",
    "Value": "Значение ответа"
  },
  "Data": {}
}

Статус

Ключ статус используется для получения информации о ответе службы. Если всё прошло правильно, в ответе в атрибуте будет указано Код значение 200 или 201. Однако может случиться так, что что-то пойдет не так, и в этом случае ответ будет выглядеть примерно так:

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

Аутентификация

Для использования веб-сервисов, доступных на этом сайте, необходимо учитывать, что аутентификация доступа является базовой и для этого используются учетные данные API — имя пользователя и пароль, — которые можно получить через вашу учетную запись MasterBase®.

Использование этих средств будет зависеть от языка, выбранного для получения услуг, и ответственность за это несет лицо, получающее такие услуги.