Введение

Добро пожаловать в документацию по Плюсофон API.

Плюсофон API позволяет управлять аккаунтами и звонками внутри ОАТС посредством использования HTTP запросов. Помимо стандартных функций ОАТС API предоставляет доступ к сервису двухфакторной аутентификации. Функциональные возможности API постоянно расширяются.

Описание каждого модуля начинается с краткого обзора его возможностей. Далее следует подробное описания каждого метода, которое включает в себя описание структуры запроса-ответа и, по возможности, сопровождается примерами.

Запрос

Плюсофон API работает по протоколу JSON-RPC [1]. Название метода, как правило, состоит из названия модуля, к которому обращается клиент, и названия метода в этом модуле и разделяется символом «/». Структура запроса:

Параметр Описание Пример
jsonrpc Версия протокола 2.0
method Название API метода user/about-me
id ID сообщения f3gk6fsd56
params Параметры метода {}

Предупреждение

На данный момент API использует версию 2.0 и поддерживает вызов процедур только с именованными параметрами.

Ответ

В ответ всегда возвращается JSON объект. Если запрос обработан успешно, параметр «result» будет содержать данные, которые вернул метод. Если произошла какая-либо ошибка, значение параметра «result» будет равняться NULL, а ответ будет содержать в себе параметр «error», в котором будет указан код ошибки и ее описание.

Параметр Описание Пример
jsonrpc Версия протокола 2.0
id ID сообщения f3gk6fsd56
result Данные, которые вернул метод или NULL {«email»:»my@email.ru»}
error NULL или код и описание ошибки {«error»: null}

Аутентификация

Для аутентификации пользователя, в HTTP запросе необходимо передавать заголовок «Authorization»:

curl -H "Authorization: Bearer $TOKEN" https://api.plusofon.ru

Примечание

[1]Подробную информацию по протоколу можно найти на wikipedia.