Основное преимущество API в MasterBase® заключается в том, что они позволяют автоматизировать действия, выполняемые вручную на веб-платформе.
Кроме всего прочего, они делают это возможным:
Обновляйте базы данных в своей рабочей среде и на нашей платформе одновременно.
Создавайте и отправляйте сообщения из своих систем без необходимости входа в нашу платформу.
Получите от MasterBase® метрики ваших отгрузок
MasterBase® API
Узнайте о наших API
Что такое API MasterBase® и для чего они нужны?
Чтобы создать URL-адрес сервиса, который вы хотите использовать, необходимо использовать следующую структуру:
Базовый URL, объединяющий веб-сервисы:
https://api2023.masterbase.com
к которому сначала нужно добавить сегмент, указывающий на сервис, на который он указывает, а затем необязательные параметры, определяющие ваш запрос. Перед первым из них ставится знак вопроса (?), затем знак равенства (=) и значение параметра. При добавлении второго параметра вместо вопросительного знака следует использовать знак амперсанда (&).
Пример:
https://api2023.masterbase.com/contacts/v2/ClientName/?From=123&Top=100&Заказ=1
Структура
Конверт
Каждый ответ содержится в структуре, называемой конверт (конверт, обертка). Это означает, что каждый ответ имеет предопределенную структуру, с которой он может взаимодействовать.
{
"Сервис": "Название сервиса",
"Version": "Версия сервиса",
"TransactionId": "Буквенно-цифровой идентификатор транзакции",
"Status": { "Статус": {
Code": "Код ответа", "Code": "Код ответа", "Value": "Значение ответа",
"Value": "Значение ответа", "Value": "Значение ответа
},
"Data": {}
}
Статус
Ключ статус используется для получения информации об ответе сервиса. Если все прошло правильно, то в ответе в атрибуте Code будет указано значение 200 или 201. Однако может случиться так, что что-то пойдет не так, и тогда полученный ответ будет иметь такой вид:
"Статус": {
"Код": "401",
"Value": "Unauthorized"
}
Аутентификация
Для использования веб-услуг, доступных на этом сайте, необходимо учитывать, что аутентификация доступа является базовой, и для этого используются учетные данные API - пользователь и пароль, - которые можно получить через учетную запись MasterBase®. Их использование зависит от языка, выбранного для использования услуг, и является обязанностью пользователя.