Подключение к тестовой площадке¶
URLs:
- Web-интерфейс https://обзор.сделка.рф
- API авторизации https://journey-accounts.sdelka-rf.ru
- API обмена https://journey.api.sdelka-rf.ru
⚡ Все запросы по авторизации и работе с API также можно выполнять, используя web-интерфейс Swagger UI.
Шаг 1. Регистрация¶
Зарегистрируйтесь на обзор.сделка.рф.
После регистрации на указанный почтовый адрес придут 2 пары логин-пароль для доступа:
- Почта с тегом
+buy
- это автоматически созданная учётная запись покупателя. - Почта с тегом
+sell
- это автоматически созданная учётная запись продавца - менеджера со стороны застройщика.
Шаг 2. Аутентификация. Получение токена¶
Для полноценной работы с API нужно использовать пару с тегом
+sell
.
Для получения OAuth-токена нужно отправить запрос на адрес https://journey-accounts.sdelka-rf.ru/auth_token
с параметрами:
client_id=test
- фиксированное значение для тестовой площадки;client_secret=test
- фиксированное значение для тестовой площадки;username=<val>
- вместо<val>
подставьте почту с тегом+sell
из письма, полученного на Шаге 1;password=<val>
- пароль из письма.
Пример запроса аутентификации:
curl \
--location \
--request POST \
'https://journey-accounts.sdelka-rf.ru/auth_token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'client_id=test' \
--data-urlencode 'client_secret=test' \
--data-urlencode 'username=<username>' \
--data-urlencode 'password=<password>' \
--data-urlencode 'scope='
В ответ должен прийти JSON с токенами:
{"token_type":"Bearer","expires_in":3600,"access_token":"<access_token>","refresh_token":"<refresh_token>"}
Шаг 3. Тестовый запрос к API¶
Для работы с основным API используется access_token
.
Тестовый запрос для проверки подключения:
curl -X 'GET' \
'https://journey.api.sdelka-rf.ru/client-exchange/v1/hello' \
--header 'Authorization: Bearer <access_token>' \
--header 'accept: application/json'
В случае успеха придёт ответ с приветствием:
{"message":"Hello, \u0421\u043f\u0430\u043d\u0447 \u0411\u043e\u0431 \u0421\u043a\u0432\u0435\u0430\u043f\u044d\u043d\u0442\u0441!"}
Этот же ответ но с JSON unescaped:
{"message":"Hello, Спанч Боб Сквеапэнтс!"}
Шаг 4. Перевыпуск токена¶
access_token
протухает через час и после этого его нужно перевыпустить.
Есть 2 способа как перевыпустить токен:
- Повторить запрос выше.
- Выполнить запрос на обновление токена (предпочтительно).
Пример запроса на обновление токена:
client_id=test
- фиксированное значение для тестовой площадки;client_secret=test
- фиксированное значение для тестовой площадки;refresh_token=<val>
- вместо<val>
подставьтеrefresh_token
из ответа с Шага 2;
curl \
--location \
--request POST \
'https://journey-accounts.sdelka-rf.ru/auth_token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'client_id=test' \
--data-urlencode 'client_secret=test' \
--data-urlencode 'refresh_token=<refresh_token>' \
--data-urlencode 'scope='
В ответ должен прийти такой же JSON с токенами как и при обычной аутентификации:
{"token_type":"Bearer","expires_in":3600,"access_token":"<access_token>","refresh_token":"<refresh_token>"}