Авторизация
Токен, полученный для Public API, необходимо указывать в заголовке X-API-Auth-Token при каждом запросе к API. Токен может быть отозван/заблокирован/удалён через web-интерфейс IWTM. В случае, если это произойдет, токен считается недействительным. При указании недействительным токена возвращается сообщение об ошибке с кодом 401.
{
"error": {
"code": "unauthorized"
}
}
Если токен действующий, но у пользователя API недостаточно прав, то пользователю возвращается сообщение об ошибке с кодом 403.
{
"error": {
"code": "forbidden"
}
}
Версионирование
Версия API передается с помощью заголовка X-API-Version и может иметь 3 состояния:
- supported — версия поддерживается и активно развивается;
- deprecated — версия доступна, но перестала поддерживаться. Рекомендуется перейти на новую версию, так как в следующих выпусках эта версия может быть удалена;
- removed — версия полностью удалена из продукта.
В случае, если сервер не поддерживает версию, ему возвращается сообщение об ошибке с кодом 400.
{
"error": {
"code": "unsupported_version",
"meta": {
"versions": [
{
"NAME": "1",
"STATUS": "removed"
},
{
"NAME": "1.1",
"STATUS": "deprecated"
},
{
"NAME": "1.2",
"STATUS": "supported"
}
]
}
}
}
Лицензирование
Для работы модуля требуется лицензия:
{
"common_name": "iw",
"importer_name": "dome"
}
Где common_name — это название лицензируемой компании, а importer_name — продукт, который принимает данные от ТМ.
{
"error": {
"code": "licence_not_valid"
}
}
Таким образом, каждый запрос к серверу должен содержать следующие обязательные заголовки:
- X-API-Version – указывается номер версии программного интерфейса. Текущая версия: 1.2;
- X-API-CompanyId – указывается идентификатор компании-производителя, например: iw;
- X-API-ProductName – указывается продукт, принимающий данные, например: dome;
X-API-Auth-Token – указывается токен авторизации.
Важно
В версии продукта 6.10.10 номер версии программного интерфейса X-API-Version: 1.2
X-API-Version: 1.2 X-API-CompanyId: iw X-API-ProductName: dome X-API-Auth-Token: gla20dos1pcdbr69caxz