Серверная OAuth-авторизация в ОК

В настройках приложения укажите redirect_uri, который будет использоваться во время авторизации OAuth.

Шаг 1. Как открыть диалог авторизации OAuth

Чтобы начать процесс авторизации, откройте новое окно браузера или webView и реализуйте переход на специально сформированный URL: https://connect.ok.ru/oauth/authorize?client_id={clientId}&scope={scope}&response_type ={{response_type}}&redirect_uri={redirectUri}&layout={layout}&state={state}

Параметр	Обязательность	Описание
client_id	Да	Идентификатор приложения application id
scope	Да	Запрашиваемые права приложения, разделенные символом ;
response_type	Да	Тип ответа от сервера. Укажите code
redirect_uri	Да	URI, куда будет передан access_token. Должен посимвольно совпадать с одним из URI, зарегистрированных в настройках приложения. Часть URI после символа ? (query) не учитывается при проверке. Для передачи данных, которые меняются динамически, рекомендуем использовать параметр state
layout	Нет	Внешний вид окна авторизации: w – стандартное окно для полной версии сайта, используется по умолчанию, m – окно для мобильной авторизации, a – упрощенное окно для мобильной авторизации без шапки
state	Нет	Параметр состояния, который в неизменном виде пробрасывается в redirect_uri. Позволяет передавать произвольные данные между разными фазами OAuth и защищаться от xsrf

Шаг 2. Как происходит работа с правами доступа

Если пользователь выдал приложению все права, указанные в параметре scope, то окно автоматически закрывается и дополнительное подтверждение от пользователя не требуется. После перехода по сформированному URL пользователь должен будет ввести свой логин и пароль, если не сделал этого ранее. После входа на сайт ему будет предложено авторизовать приложение и подтвердить запрошенные права.

Разрешение прав

Шаг 3. Как получить code

Обратите внимание
Если вы используете OAuth в игровых приложениях, которые размещены вне социальной сети Одноклассники, требуется подключать OAuth того же приложения, которое используется в версии на платформе ОК.

Пользователи, которые раньше играли в приложение на платформе ОК, при авторизации через OAuth автоматически перенаправляются в соответствующую версию приложения на платформе ОК;
Пользователи, которые раньше не играли в приложение на платформе ОК, при авторизации через OAuth перенаправляться не будут.

Такое использование OАuth не расценивается как нарушение пункта 5.6 правил размещения приложений на платформе.

После подтверждения авторизации пользователь перенаправляется на redirect_uri, указанный при открытии диалога авторизации. В GET-параметрах redirect_uri будет передан ключ доступа code, а также state, если он был указан на 1 шаге: {redirect_uri}?code={code}&state={state} Полученный параметр code действует 2 минуты. Если возникнет ошибка или придет отказ от авторизации, будет передан параметр error с причиной проблемы: {redirect_uri}#error={error}&state={state}

Шаг 4. Как получить access_token

Чтобы получить access_token, выполните POST-запрос с сервера вашего сайта к API на URL: https://api.ok.ru/oauth/token.do?code={code}&client_id={client_id}&client_secret ={client_secret}&redirect_uri={redirect_uri}&grant_type={grant_type}

Параметр	Описание
code	Код авторизации, полученный на 3 шаге
client_id	Идентификатор приложения {application id}
client_secret	Защищенный ключ приложения {application_secret_key}
redirect_uri	Тот же URI переадресации, что был указан на 1 шаге
grant_type	Тип выдаваемых прав. Укажите authorization_code

В ответе от сервера приходит json, который содержит запрошенный access_token или информацию об ошибке. Пример ответа в случае успеха

{
    "access_token": "{access_token}",
    "token_type": "session",
    "refresh_token": "{refresh_token}",
    "expires_in":"{expires_in}"
}

Описание параметров ответа

Параметр	Описание
access_token	Токен доступа, который используется для формирования запроса к API
token_type	Как правило, возвращается только session
refresh_token	Токен обновления, который можно использовать далее для упрощенной процедуры авторизации. Действителен 30 суток
expires_in	Время действия токена доступа в секундах

Пример ответа в случае ошибки

{
    "error": "{error}",
    "error_description": "{error_description}"
}

Описание параметров ответа

Параметр	Описание
error	Код ошибки
error_description	Информация об ошибке

Как использовать refresh_token

С refresh_token можно получить access_token по упрощенной процедуре. Для этого выполните POST-запрос на URL: https://api.ok.ru/oauth/token.do?refresh_token={refresh_token}&client_id ={client_id}&client_secret={client_secret}&grant_type={grant_type}

Параметр	Описание
refresh_token	Маркер обновления, полученный ранее на 4 шаге
client_id	Идентификатор приложения {application id}
client_secret	Защищенный ключ приложения {application_secret_key}
grant_type	Тип выдаваемых прав. Укажите refresh_token

Формат ответа аналогичен формату при получении access_token, но в нем нет refresh_token.

Возможные ошибки

Ошибка	Описание
invalid_request	Invalid code — передан неверный code; Expired code — время действия code истекло; Wrong redirect_uri — redirect_uri отличается от переданного на этапе OAuth
invalid_client	Unknown client — не удалось найти указанное приложение
unauthorized_client	Invalid request parameters — указан неверный секретный ключ приложения
access_denied	Access denied — пользователь не авторизовал приложение, например, удалил его в настройках; Refresh token expired — время действия refesh_token истекло; Logout all — пользователь вышел со всех устройств
invalid_grant	Invalid grant type или Invalid parameters for grant type — не удалось распознать параметр grant_type
invalid_token	Session expired — не удалось определить пользователя; Invalid refresh token / Invalid refresh token structure / Invalid refresh token, user not found — refresh_token был передан неверно