Использование REST API

Телекоммуникационная платформа Webitel предоставляет возможность внешним разработчикам программными средствами управлять настройками и звонками. Одним из способов такого взаимодействия является использование REST API.

Что такое REST API

REST API определяет набор функций, к которым разработчики могут совершать запросы и получать ответы. Взаимодействие происходит по протоколу HTTP. Преимуществом такого подхода является широкое распространение протокола HTTP, поэтому REST API можно использовать практически из любого языка программирования.

Авторизация запросов

Для выполнения REST API запроса, необходимо в Header передавать X-Access-Token и дополнительно X-Key для запросов от имени пользователей.

Для получения Access Token, вы можете выполнить команду login используя логин и пароль любого пользователя Webitel:

POST /login HTTP/1.1
Content-Type: application/json

{
  "username": "100@mydomain.com",
  "password": "secret"
}

В ответе получите X-Access-Token и X-Key. Все дальнейшие запросы с использованием данных X-Access-Token и X-Key будут выполняться с правами и от имени этого пользователя.

Другой вариант - Domain Token:

Вы сами задаете роль и срок действия такого ключа. В запросах необходимо помещать в Header только X-Access-Token со значением данного ключа.

Примеры популярных запросов

Ниже приведен список популярных запросов с использованием Domain Token.

Так же у Вас есть возможность ознакомиться с исходным кодом Webitel Client, функционал которого полностью реализован с использованием Webitel REST API.