Спецификация API (Swagger UI)

Актуальная версия спецификации описана в формате Swagger.

Как выполнять запросы через Swagger UI

1. Зарегистрируйтесь на обзор.сделка.рф или получите параметры доступа у менеджера

Подробнее об этом в Подключение к тестовой площадке и Подключение к Production.

2. В зависимости от среды выполните авторизацию в Swagger UI

• Перейдите в Swagger UI.
• Выберите Server, соответствующий среде (обзор-journey или production).
• Откройте форму авторизации.

• Выберите способ авторизации:
  • если тестируете обзор.сделка.рф, то journey_auth;
  • если хотите проверить на production, то production_auth;
  • если есть auth_token, то apiKey - работает для любой среды.
• Заполните форму:
  • Для передачи client_id и client_secret укажите location Request body. Для обзора-journey используйте client_id: test, client_secret: test.
  • Отметьте scopes = default.
• Нажмите Authorize.

3. Выполните запрос

Для тестирования можно вызвать REST-метод GET /hello:

Нажмите Try Out:

Затем Execute:

В ответе будет ФИО авторизованного пользователя: