REST APIs

Make your first call

Чтобы вызвать REST API, создайте приложение Steein REST и получите access token:

Чтобы получить access token, вы должны создать приложение в Steein. Когда вы создаете приложение, Steein генерирует набор OAuth client_id и secret ключи для вашего приложения. Затем, чтобы получить токен доступа, вы передаете client_id:secret учетные данные в заголовке Authorization в запросе access token. Сервер авторизации выдает токен доступа в обмен на ваш идентификатор клиента и секретные учетные данные. Вы используете токен доступа для аутентификации при выполнении запросов REST API.

   
1. Создайте приложение REST для Steein.
Когда вы создаете приложение, Steein генерирует набор учетных данных OAuth.
OAuth является безопасным способом доступа к API.
2. Получить токен доступа.
Передайте учетные данные OAuth при вызове токена доступа.
В ответ сервер авторизации Steein выдает токен доступа.
3. Сделать вызовы REST API.
Используйте токен доступа для аутентификации при выполнении вызовов REST API.

Создание приложения Steein

На странице разработчикам нажмите «Мои приложения».

В разделе «Мои приложения» нажмите «Создать приложение».

Steein генерирует набор OAuth client_id и secret учетных данных для вашего приложения.

Получить токен доступа

Конечной точкой доступа является /oauth/token

.

Чтобы получить токен доступа, вы передаете свои учетные данные OAuth в вызове токена доступа. Чтобы выполнить этот вызов, вы можете использовать cURL в командной строке.

В ответ сервер авторизации Steein выдает токен доступа.

Пример cURL

  1. Скачать cURL для вашей среды.

  2. В командной строке выполните следующую команду:

    
    curl -v https://www.steein.ru/oauth/token \
       -H "Accept: application/json" \
       -H "Accept-Language: ru_RU" \
       -u "client_id:secret" \
       -d "grant_type=client_credentials"
    
    

    Где:

    /oauth/token Конечная точка токен доступа.
    client_id Идентификатор клиента.
    secret Секретный ключ приложения
    grant_type Tип гранта. Установлен в client_credentials.
  3. Посмотреть ответ образца.

Советы:

  • Если вы используете Windows, используйте оболочку Bash для вызова cURL.
  • Если вы используете инструмент командной строки, отличный от cURL, установите content-type в application/x-www-form-urlencoded.

 

Пример ответа

{
  "scope": "users posts",
  "nonce": "2017-06-08T18:30:28ZCl54Q_OlDqP6-4D03sDT8wRiHjKrYlb5EH7Di0gRrds",
  "Access-Token": "Access-Token",
  "token_type": "Bearer",
  "app_id": "",
  "expires_in": 331135
}

Где:

Access-Token Ваш токен доступ.
expires_in Количество секунд, после которых истекает токен. Запросить другой токен, когда истекает текущий.

Сделать вызовы REST API

Имея действительный токен доступа, вы можете совершать вызовы REST API.

Этот примерный вызов создает нового пользователя в Steein и использует только необходимые входные параметры. Маркер доступа в вызове - токен канала OAuth.


curl -v -X POST https://www.steein.ru/api/v2.0/auth/register \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token" \
-d '
{
	"last_name": "LastName",
	"first_name":"Name",
	"email": "support@steein.ru",
	"password": "123456"
}'

Успешный вызов возвращает тело ответа JSON с деталями регистрации.