Авторизация
API key
Стандартный способ использования API-интерфейса - использование ключа доступа к API (key). Его можно получить в Личном кабинете в разделе Настройки - Настройки API. В этом же разделе можно отозвать ранее выданный ключ, сформировав новый.
Этот ключ необходимо передавать во всех HTTP(S) запросах к сервису параметром GET или POST. Помимо ключа, в запросе должен быть параметр project, который указывается в URI запроса.
Пример вызова со следующими значениями:
- project = mycompany (реквизит доступа к API)
- key = 123 (реквизит доступа к API)
- phone = 79991112233 (номер телефона для подключения
- title = Test (название объекта)
- tariffid = 4 (тарифный план)
https://movizor.ru/api_2/mycompany/object_add/?phone=79991112233&title=Test&tariff=4&key=123
oAuth
Альтернативный способ авторизации, используемый для доступа по API к аккаунту существующего клиента. Рекомендуется использовать этот способ при интеграции сервиса в сторонний продукт/приложение/сервис, так как он легче для активации со стороны клиента.
Простой принцип действия - при отсутствии у вашего приложения токена (token) нужного клиента, открыть клиенту окно со следующим адресом:
https://movizor.ru/oauth/authorize/?app_id=1&redirect_url=http://localhost/
Если клиент уже авторизован в нашем сервисе, ему будет предложено открыть доступ к аккаунту для вашего приложения:
При нажатии на Разрешить доступ, будет сформирован код получения токена code, по которому ваше приложение может получить полноценный token для доступа по API к аккаунту пользователя. Браузер посетителя будет переадресован на redirect_url (если пусто, то на https://movizor.ru/oauth/blank/), в GET-параметрах которого будет code для доступа к token:
http://localhost/?code=77a04169132674e0
Ваше приложение в течение 5 минут должно сделать отдельный HTTPS-запрос для обмена кода на полноценный token:
https://movizor.ru/oauth/code/?code=77a04169132674e0
Ответ:
{"code":"OK","message":"Token created","result":"success","data":{"app_id":"1","client_id":"70123","token":"12bf14ce521713adb5bf2cc6416252eb87d7eee23a0ea1b468d4b1e282961a1"}}
Имея полноценный token, можно выполнять запросы к API-интерфейсу от имени клиента. Например:
https://movizor.ru/api_2/app/object_add/?phone=79991112233&title=Test&tariff=4&token=12bf14ce521713adb5bf2cc6416252eb87d7eee23a0ea1b468d4b1e282961a1
Данный запрос будет сделан в аккаунте клиента 70123. Все тарифицируемые действия оплачиваются с его аккаунта.
Для активации этого способа авторизации, обратитесь в нашу Службу поддержки с описанием вашего приложения/сервиса.