Список REST - методов
Все методы API доступны с помощью GET и POST запросов.
Каждый метод доступен по 2 URL:
{api_server}fb.do?method=[method_name] - например, https://api.ok.ru/fb.do?method=friends.get
{api_server}api/[method_group]/[method_name] - например, https://api.ok.ru/api/friends/get
В качестве {api_server} должен использоваться соответствующий GET-параметр. Если он отсутствует, то используется https://api.ok.ru/
Общие параметры запроса
| Имя | Требуется | Тип | Описание |
|---|---|---|---|
| application_key | Да | String | Публичный ключ приложения |
| sig | Да | String | Подпись запроса |
| session_key/access_token | Нет | String | Сессия пользователя. Параметр может быть обязательным, выборочным или запрещенным в зависимости от метода |
| format | Нет | String | Формат ответа метода, в данный момент поддерживается только формат JSON |
| call_id | Нет | Long | Порядковый номер запроса |
| __online | Нет | Boolean | Отмечать ли пользователя онлайн (эффективно для приложений мессенджеров). По умолчанию true |
Расчет подписи запроса
- при отсутствии значения session_secret_key:
- для вызова без сессии считаем session_secret_key = application_secret_key;
- для вызова в сессии session_secret_key = MD5(access_token + application_secret_key), переводим значение в нижний регистр;
- убираем из списка параметров session_key/access_token при наличии;
- параметры сортируются лексикографически по ключам;
- параметры соединяются в формате ключ=значение;
- sig = MD5(значения_параметров + session_secret_key);
- значение sig переводится в нижний регистр.
Параметры приложения
Данные о сессии пользователя
| | |||||||
Метод
Список параметров
Используем для подписи secret_key = session_secret_key
Используем для подписи secret_key = application_secret_key
Используем для подписи secret_key = MD5(access_token + application_secret_key)
secret_key =
Сортируем и склеиваем параметры запроса и secret_key
Рассчитываем MD5 от полученной строки и получаем параметр sig