История страницы

Sv translation

language	ru

Авторизация

Токен, полученный для Public API, необходимо указывать в заголовке X-API-Auth-Token при каждом запросе к API. Токен может быть отозван/заблокирован/удалён через web-интерфейс IWTM. В случае, если это произойдет, токен считается недействительным. При указании недействительным токена возвращается сообщение об ошибке с кодом 401.

Блок кода

title	Пример ответа при недействительном токене

{
    "error": {
        "code": "unauthorized"
    }
}

Если токен действующий, но у пользователя API недостаточно прав, то пользователю возвращается сообщение об ошибке с кодом 403.

Блок кода

title	Пример ответа при нехватке прав

{
    "error": {
        "code": "forbidden"
    }
}

Версионирование

Версия API передается с помощью заголовка X-API-Version и может иметь 3 состояния:

supported — версия поддерживается и активно развивается;
deprecated — версия доступна, но перестала поддерживаться. Рекомендуется перейти на новую версию, так как в следующих выпусках эта версия может быть удалена;
removed — версия полностью удалена из продукта.

В случае, если сервер не поддерживает версию, ему возвращается сообщение об ошибке с кодом 400.

Блок кода

title	Ответ в случае некорректной версии

{
    "error": {
        "code": "unsupported_version",
        "meta": {
            "versions": [
                {
                    "NAME":   "1",
                    "STATUS": "removed"
                },
                {
                    "NAME":   "1.1",
                    "STATUS": "deprecated"
                },
                {
                    "NAME":   "1.2",
                    "STATUS": "supported"
                },
                {
                    "NAME":   "1.3",
                    "STATUS": "supported"
                }
            ]
        }
    }
}

Лицензирование

Для работы модуля требуется лицензия:

Блок кода
{ "common_name": "iw", "importer_name": "dome" }

Где common_name — это название лицензируемой компании, а importer_name — продукт, который принимает данные от ТМ.

В каждом запросе нужно передавать заголовки X-API-CompanyId и X-API-ProductName. В случае, если лицензия не проходит проверку, возвращается сообщение об ошибке с кодом 403.

Блок кода

title	Формат ответа при невалидной лицензии

{
    "error": {
        "code": "licence_not_valid"
    }
}

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

X-API-Version – указывается номер версии программного интерфейса. Текущая версия: 1.23;
X-API-CompanyId – указывается идентификатор компании-производителя, например: iw;
X-API-ProductName – указывается продукт, принимающий данные, например: dome;
X-API-Auth-Token – указывается токен авторизации.
Предупреждение
title Важно
В версии продукта 6.10.10 номер версии программного интерфейса X-API-Version: 1.2

Блок кода

title	Пример запроса

X-API-Version: 1.23
X-API-CompanyId: iw
X-API-ProductName: dome
X-API-Auth-Token: gla20dos1pcdbr69caxz

Sv translation

language	en

Authorization

Token received for Public API should be specified within X-API-Auth-Token header in each API request. The token can be canceled, blocked/deleted via IWTM interface. In this case, the token is considered to be invalid. When the token is invalid, 401 error message will be returned.

Блок кода

title	Error message example when token is invalid
collapse	true

{
    "error": {
        "code": "unauthorized"
    }
}

If the token is valid, but API user has no sufficient access rights, 403 error message will be returned.

Блок кода

title	Error message when user has no sufficient access rights
collapse	true

{
    "error": {
        "code": "forbidden"
    }
}

Versions

API version is sent via X-API-Version header and can be in one of the following states:

supported — the version is supported and actively developing
deprecated — the version is available but no longer supported. We recommend upgrading to a newer version as this version can be removed in future releases
removed — the version is completely removed from the product

In case the server does not support the version, 400 error message is returned.

Блок кода

title	Response if the version is incorrect
collapse	true

{
    "error": {
        "code": "unsupported_version",
        "meta": {
            "versions": [
                {
                    "NAME":   "1",
                    "STATUS": "removed"
                },
                {
                    "NAME":   "1.1",
                    "STATUS": "deprecated"
                },
                {
                    "NAME":   "1.2",
                    "STATUS": "supported"
                },
                {
                    "NAME":   "1.3",
                    "STATUS": "supported"
                }
            ]
        }
    }
}

Licenses

To operate properly, the module requires a license as follows:

Блок кода
{ "common_name": "iw", "importer_name": "dome" }

Where common_name — is a name of a licensed company and importer_name — is a product, receiving data from TM. X-API-CompanyId and X-API-ProductName headers should be sent in each request. In case the license is rejected 403 error message will be returned.

Блок кода

title	Respond when the license is invalid.
collapse	true

{
    "error": {
        "code": "licence_not_valid"
    }
}

Thus, each request to the server should contain the following obligatory headings:

X-API-Version – a version of the programming interface is specified. Current version: 1.23;
X-API-CompanyId – an identifier of the vendor is specified, e.g. iw;
X-API-ImporterName – data receiving product is specified, e.g. dome;
X-API-Auth-Token – the authorization token is specified.

Предупреждение

title	Warning!

In 6.10.10 version X-API-Version program interface number is 1.2

Блок кода

title	Example of request

X-API-Version: 1.23
X-API-CompanyId: iw
X-API-ProductName: dome
X-API-Auth-Token: gla20dos1pcdbr69caxz

Show all results

Дерево страниц

Сравнение версий

Старая версия 1

Новая версия 2

Ключ

Авторизация

Версионирование

Лицензирование

Authorization

Versions

Licenses