API документация для разработчиков
В данном разделе представлено подробное описание методов обращения к Api, списки их параметров с допустимыми значениям, а также ответы в формате Json.
Инструкция по использованию API SaraFann
- 1) Зарегистрировать в тех.поддержке приложение для работы с АПИ, передав оператору значение redirect_url
- 2) Получить от тех.поддержки application_id и application_secret
- 3) Для работы с сервера:
- 1. Для авторизации приложения нужно сделать запрос GET https://oauth.sarafann.ru/authorize?application_id={application_id}&redirect_url={redirect_url}
- 2. В ответе придёт access_token для приложения. С ним можно делать любые запросы, не требующие авторизацию.
- 3. Для получения токена пользователя - нужно авторизовать пользователя. Для этого нужно сделать POST запрос на адрес https://api.sarafann.ru/method/auth.sendSms с параметрами:
- - phone - номер телефона (либо email)
- - access_token - токен приложения, полученный выше (п. 4)
- - v - версия АПИ. На данный момент актуальная версия 1.11
- 4. Если в ответе нет ошибок - нужно сделать ещё 1 POST запрос на адрес https://api.sarafann.ru/method/auth.confirmCode с параметрами
- - code - код из СМС
- - token - Токен из ответа на предыдущий запрос
- - access_token - токен приложения, полученный выше (п. 4)
- - v - версия АПИ. На данный момент актуальная версия 1.11
- 8. В ответе придёт токен пользователя. С ним Вы можете делать уже все действия, включая требующие авторизацию. Достаточно добавить его в качестве параметра access_token в запросе.
- 4) Для работы из браузера:
- 1. Авторизоваться на сайте sarafann.ru
- 2. Перейти по ссылке https://oauth.sarafann.ru/authorize?application_id={application_id}&redirect_url={redirect_url}
- 3. Сайт сделает редирект на Ваш домен и передаст туда переменную code
- 4. Её нужно отправить на адрес https://api.sarafann.ru/oauth/authorizeUser?code={$code}&application_id={$appID}&application_secret={$appSecret}
- 5. В ответе придёт access_token для пользователя.
<?php
$code = $_GET['code'];
$appID = 123;
$appSecret = "1382d0a2dcdc0f4ba0b98603fbb0a326";
$url = "https://api.sarafann.ru/oauth/authorizeUser?code={$code}&application_id={$appID}&application_secret={$appSecret}";
$data = file_get_contents($url);
// Тут Вы можете записать данные к себе, либо отобразить их на странице. Либо сделать что-то ещё.
echo $data;
?>