...
Для работы с API необходимо получить токен, кроме того, на стороне разработчика следует определить политику работы с токеном:
можно создать токен, который годен условно бесконечное время, и генерить его заново в том случае, если безопасность токена скомпрометирована;
можно создать токен, который годен в течение короткого времени (например, в течение одного дня) и автоматически генерить токен по завершению периода его годности.
...
Trace - информация, которую необходимо предоставить в службу поддержки для анализа инцидента:
ResponseDate - дата и время формирования ответа;
SessionID - идентификатор сеанса. По нему сотрудник поддержки сможет найти лог взаимодействия;
IP - адрес, с которого было отправлено обращение;
WebSite - название сайта, на котором был выполнен данный запрос.
Errors - коллекция ошибок. Каждая ошибка содержит в себе тип ошибки и описание.
Type - тип ошибки. Классические типы ошибок следующие:
ValidationException - ошибка целостности данных (например, обращение к недоступному объекту);
InvalidDataException - ошибка валидации данных (например, передан пустой email или номер телефона);
AccessRightsException - ошибка, связанная с валидацией прав (например, если из-под агента обращаться к данным клиента, не выполнив предварительно вход от имени клиента).
Text - текстовое сообщение с деталями ошибки;
ResponseDetails - контейнер, содержащий ответ на запрос.
Пример успешного ответа:
...
Пример ответа с ошибкой:
...
Соответственно, по SessionID сотрудник службы поддержки может найти событие в журнале запросов:
...