GetToken POST GET

Возвращает маркер доступа.

Маркер доступа можно использовать для выдачи пользователям, с целью сохранения в тайне идентификатора и секретного ключа приложения. Это актуально при работе с API со стороны клиента, когда исходный код открыт.


Запросы следует отправлять на адрес:

Анонимные запросы запрещены. Требуется авторизация.

Поддерживаются запросы методом GET и POST.

По умолчанию ответ сервера будет в формате JSON. Для получения ответа в другом формате, можно добавить расширение к файлу в адресе: .xml, .html или .txt. Например: /v2/GetToken.xml Либо использовать HTTP-заголовок Accept: text/xml, text/html или text/plain.


Параметры

Имя параметра Тип Обязательный По умолчанию Описание
lifetime Int32 Нет 20 Срок действия маркера доступа. Значение в минутах, но не более 1 440 минут.
Общие параметры

В таблице ниже представлен список параметров, которые могут быть использованы при запросе к любому методу API.

Имя параметра Тип Обязательный По умолчанию Описание
appId Int32 Нет NULL Идентификатор приложения.
appSecret String Условно NULL Секретный ключ приложения.
token String Нет NULL Маркер доступа клиента, полученный методом GetToken.
formatting ResponseFormatting Нет None Определяет параметры форматирования выдачи результатов.
details Boolean Нет False Позволяет отобразить дополнительную информацию о запросе.
cp String Нет UTF-8 Имя кодовой страницы.
lang Language Нет Auto Язык, на котором будут выдаваться системные сообщения. Этот параметр также можно использовать при работе со справочной информацией API.
auth Boolean Нет False При наличии этого параметра, сервер вернет ответ с кодом HTTP401 и потребует указание идентификатора приложения и секретного ключа в HTTP заголовке Authorization.

Результат

Возвращает результат типа StringResult.

Имя свойства Тип Описание
Исходное XML JSON
Value value value String Строка, содержащая результат выполнения операции.
Messages messages messages Message[] Список сообщений системы.
Trace trace trace TraceItem[] Детальная информация о выполнении запроса. Добавляется, если параметр details имеет значение True.

Имя XML и JSON используется при выдаче результатов в XML и, соответственно, JSON.

Если имя XML начинается с символа «собака» (@), то значит в XML это имя будет использоваться в качестве имени атрибута, а не самостоятельного элемента.

Исходное имя - это имя, которое используется непосредственно в коде API.


Ошибки

При возникновении ошибок, будет возвращаен результат типа ErrorResult.

В таблице ниже представлен список ошибок, которые могут возникнуть при работе с методом GetToken.

Ключ Код Описание
AccessDenied 1100 Ошибка возникает при попытке выполнить запрос без указания параметров доступа, либо при отсутствии разрешений на доступ к данным.

Ключ и код соответствуют элементам перчисления ErrorCode.

В некоторых случаях, в ответе сервера могут содержать предупреждения (Warning) и сообщения о проблемах (Critical), которые можно найти в коллекции Messages. При этом, ответ сервера будет иметь тип StringResult.

Если метод содержит сообщения типа Critical, то можно считать, что работа метода завершена с ошибкой. Подобное поведение свойствено методам, в которых производится обработка списка данных, где каждый элемент списка является независимым от других элментов. Т.е. в таких случаях запрос может быть выполнен частично.


Примечания

Получить маркер доступа можно только с использованием appId и appSecret!

Получение маркера доступа с использованием существующего маркера доступа невозможно.

Маркер доступа привязывается к appId, с которого он был создан. Нет необходимости указывать appId и appSecret при работе с API с использованием маркера доступа.

Маркер доступа не является секретным, его можно передавать, как есть, клиенту, для которого он запрашивался.

После получения маркера доступа, вы должны его сохранить для дальнейшего использования. Например, передать в базу данных или файлы cookies клиента.

Маркер доступа действует только для одного IP-адреса.

Маркер доступа привязывается к IP-адресу, с которого будет осуществлен первый запрос к API. При использовании маркера доступа для запросов с других IP-адресов, сервер будет возвращать ошибку: «Доступ запрещен».

Срок действия маркера доступа по умолчанию равен 20 минутам.

Срок действия можно увеличить, но он не может быть больше 24 часов.

Маркер доступа можно передавать в параметрах запроса, указав значение в параметре token.

Для повышения безопасности, рекомендуется передавать маркер доступа не в параметрах запроса, а в HTTP-заголовке Authorization, с использованием типа авторизации Bearer.
Например: Bearer: 5ac332951977401ca4663b6098572f2e, где 5ac332951977401ca4663b6098572f2e является полученным маркером доступа.

При использовании appId и appSecret одновременно с маркером доступа, приоритет будет у appId.


Статистика


Конструктор запросов

lifetime:

http:
lang:
auth:
cp: