Запрос

URI параметр

NONE

Передаваемые параметры

SecurityModel
Name Description Type Additional information
ApiKey Ключ авторизации для WebAPI. globally unique identifier

None

Примеры

Необходимые данные для авторизации (запрашиваются у вашего менеджера):
login - логин клиента
password - пароль клиента
apiKey - ключ api

Необходимые ключевые значения в заголовке POST запроса на авторизацию (тип авторизации Basic):
Authorization: Basic UE9ETEVUUzEyMzp4eHh4eHh4eHg= (пример вычисления значения на JS: 'Basic ' + window.btoa(unescape(encodeURIComponent(login + ':' + password))), где login и password - ваш персональный логин и пароль предоставленный менеджером)
Необходимые данные в теле POST запроса на авторизацию:
{"ApiKey":"6F23F19D-E620-489F-B44C-70F76D60C3A1"} (пример тела запроса в JSON формате, где значением ApiKey будет являться ваш персональный apiKey предоставленный менеджером)
После успешной авторизации в ответном заголовке Response Header приходит токен вида:
Token: adf90452-731c-4d39-ba47-bb5a3290fc40

Для вызова остального функционала Api в заголовке Request Header каждого запроса указывается токен, полученный выше вида:
Token: adf90452-731c-4d39-ba47-bb5a3290fc40 (пример заголовка с токеном)

Request Formats

application/json, text/json

Sample:
{
  "ApiKey": "aedbfa81-3388-4491-861e-4534587377d8"
}

text/xml

Sample:
<SecurityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.Model">
  <ApiKey>aedbfa81-3388-4491-861e-4534587377d8</ApiKey>
</SecurityModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Ответ

Описание ответа

HttpResponseMessage. После успешного POST запроса на авторизацию в ответном заголовке Response Header содержится строка с токеном вида Token: adf90452-731x-4d39-b247-bb5a3290fc40, которую необходимо добавлять ко всем последующим запросам в Request Header для работы с Api

HttpResponseMessage
Name Description Type Additional information
Version Version

None

Content HttpContent

None

StatusCode HttpStatusCode

None

ReasonPhrase string

None

Headers Collection of Object

None

RequestMessage HttpRequestMessage

None

IsSuccessStatusCode boolean

None