Для доступа к API Leader-ID с партнерского сайта предусмотрен механизм серверной авторизации на базе протокола OAuth 2.0.

Авторизация по протоколу OAuth включает следующие шаги:

1. Регистрация приложения: Вы должны зарегистрировать свое приложение на странице — https://leader-id.ru/developers. В процессе регистрации вы получите идентификатор клиента (client_id) и секретный ключ клиента (client_secret), которые будут использоваться для аутентификации вашего приложения.

2. Перенаправление пользователя: Ваше приложение должно перенаправить пользователя на страницу авторизации платформы — https://leader-id.ru/apps/authorize, где у пользователя будет запрошено предоставление разрешение вашему приложению на доступ к его данным.

3. Авторизация пользователя: Пользователь должен войти в свою учетную запись и дать разрешение вашему приложению на доступ к его данным. После того, как пользователь даст согласие, платформа OAuth создаст временный код авторизации.

4. Получение временного кода авторизации: Ваше приложение получает временный код авторизации, который можно использовать для получения токена доступа. Временный код будет передан обратно вашему приложению через параметр в URL-адресе перенаправления.

5. Обмен временного кода на токен доступа: Ваше приложение отправляет запрос на обмен временного кода авторизации на токен доступа, используя ваш идентификатор клиента (client_id), секретный ключ клиента (client_secret). Запрос проходит через сервер авторизации платформы OAuth.

6. Получение токена доступа: Если запрос на обмен временного кода верен и аутентификация проходит успешно, сервер авторизации выдаст вашему приложению токен доступа. Этот токен будет использоваться для вызова защищенных ресурсов на API-сервере.

7. Использование токена доступа: Ваше приложение может использовать полученный токен доступа для вызова API-сервера, предоставляемого платформой OAuth. Токен передается в заголовке, чтобы сервер мог проверить его валидность и разрешить доступ к запрашиваемым ресурсам.

Открытие диалога авторизации OAuth

Для начала процесса авторизации необходимо создать окно браузера и открыть в нем диалог авторизации со следующими параметрами:

https://leader-id.ru/apps/authorize?client_id=KEY&redirect_uri=REDIRECT_URI&response_type=code

Где:

client_id — идентификатор зарегистрированного приложения на Leader-ID

redirect_uri — адрес, на который пользователь будет перенаправлен после прохождения процесса авторизации (домен указанного адреса должен соответствовать домену, указанному в настройках вашего приложения)

response_type — тип ответа

lang=en — если ваше приложение ориентировано на международных пользователей, вы можете передавать lang=en, чтобы форма авторизации автоматически отображалась на английском языке.

Если пользователь не авторизован на сайте, то в диалоговом окне ему будет предложено ввести свой логин и пароль:

При первой авторизации через ваше приложение пользователь должен дать согласие на доступ к своим данным:

Получение временного кода авторизации (`code`)

После успешной авторизации приложения браузер пользователя будет перенаправлен по адресу REDIRECT_URI, который был указан при открытии диалога авторизации. При этом код авторизации (CODE) для получения access_token будет передан в GET параметре на указанный адрес:

https://REDIRECT_URI?code=CODE

Ключ авторизации получаемый в параметре code может быть использован в течение 9 минут для получения access_token, который необходим для доступа к API.

В случае возникновения ошибки, браузер пользователя будет перенаправлен с указанием кода ошибки и описания ошибки. Пример возвращаемой ошибки:

https://REDIRECT_URI?error=invalid_request&error_description=Invalid+display+parameter

Получение токена доступа (`access_token`)

Для получения access_token необходимо выполнить POST запрос с партнерского сайта по методу Получить токен для доступа к API по адресу:

https://apps.leader-id.ru/api/v1/oauth/token

В запросе следует передать необходимые значения в параметрах client_id, client_secrete, grant_type и code.

Пример тела запроса:

{
    "client_id": "KEY", 
    "client_secret": "SECRET", 
    "grant_type": "authorization_code", 
    "code": "CODE" 
}

Обратите внимание: секретный ключ SECRET никогда не должен содержаться в коде клиентского приложения.

В результате выполнения этого запроса ваш сервер получит access_token, который будет иметь ограниченное время действия — 7 суток, а также refresh_token, который может быть использован для обновления access_token. Кроме того, вы получите уникальный идентификатор пользователя user_id, который разрешил доступ.

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

{
    "user_id": 123456,
    "user_validated": true,
    "refresh_token": "eyJ0eXA_______",
    "access_token": "eyJ0eXA_______",
}

В случае ошибки будут переданы параметры error и error_description.

{
    "error_description": "Code is out of date!",
    "error": "unauthorized_client"
}

Обновление токена доступа (`refresh_token`)

Для обновления access_token с помощью refresh_token необходимо выполнить POST запрос с партнерского сайта по методу Получить токен для доступа к API с передачей параметра refresh_token.

https://apps.leader-id.ru/api/v1/oauth/token

Пример тела запроса:

{
    "client_id": "KEY",
    "client_secret": "SECRET",
    "grant_type": "refresh_token",
    "refresh_token": "REFRESH_TOKEN"
}

В результате выполнения данного запроса ваш сервер получит новый access_token с ограниченным временем действия — 7 суток и новый refresh_token для последующего обновления access_token .

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

{
    "user_id": 123456,
    "user_validated": true,
    "refresh_token": "eyJ0eXA_______",
    "access_token": "eyJ0eXA_______"
}

Powered by Froala Editor

OAuth (Открытый протокол аутентификации)