Авторизация

АВТОМАТИЗАЦИЯ VPN СОЕДИНЕНИЙ С API VPNKI

и как с ним работать

Введение

API системы VPNKI предназначен для автоматизированной работы различных приложений с нашей системой.

Обращение пользователя к ресурсам API осуществляется путем web-запроса с использованием ключа, полученного на личной странице пользователя. API системы отображает информацию в ответ на запрос пользователя в формате JSON.

Личный ключ вы можете получить внизу любой странице "Личного кабинета". Выглядит ключ приблизительно так:

api key empty

 

API часть 1. Сбор статистики


Эта часть предназначена для сбора статистики о туннелях пользователя. Доступна любому пользователю. Все запросы осуществляются методом HTTP GET


1.1. Список всех туннелей пользователя

Отображает все туннели пользователя, ранее созданные через web-интерфейс системы или API.

Формат запроса:

https://vpnki.ru/index.php?option=com_api&format=raw&app=webservices&resource=tunnels&key=<ключ пользователя>

 

1.2. Список активных туннелей пользователя

Отображает список активных туннелей пользователя.

Формат запроса:

https://vpnki.ru/index.php?option=com_api&format=raw&app=webservices&resource=active&key=<ключ пользователя>

 

1.3. Статус туннелей пользователя

Отображает все туннели пользователя и их статус. status=0 - туннель отключен, status=1 - туннель подключен

Формат запроса:

https://vpnki.ru/index.php?option=com_api&format=raw&app=webservices&resource=stat&key=<ключ пользователя>

 


1.4. Статистика подключений всех туннелей пользователя

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

Формат запроса:

https://vpnki.ru/index.php?option=com_api&format=raw&app=webservices&resource=stat_user&key=<ключ пользователя>&ts=0000-00-00 00-00-00&te=2016-12-12 00-00-00

Где, ts - дата и время начала интервала

te - дата и время окончания интервала.

Пример: 2015-12-31 23-59-59


1.5. Статистика подключений определенного туннеля пользователя за указанный период времени


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

Формат запроса:

https://vpnki.ru/index.php?option=com_api&format=raw&app=webservices&resource=stat_tunnel&key=<ключ пользователя>&tunnel=<имя туннеля>&ts=2016-10-10 00-00-00&te=2016-10-18 00-00-00

 

Где, tunnel - имя туннеля, например user356,

ts - дата и время начала интервала,

te - дата и время окончания интервала, допускается указать словоформу NOW.

Пример: 2015-12-31 23-59-59

 

API Часть 2. Управление туннелями

 

Эта часть предназначена для автоматизированного управления туннелями. Доступна только привилегированным пользователям.

 

2.1 Добавление нового туннеля в пользовательский аккаунт

 

Использует метод HTTP GET. Добавляет новый туннель в пользовательский аккаунт. В ответном сообщении пользователь получит автоматически созданное имя туннеля и пароль.

https://vpnki.ru/index.php?option=com_api&format=raw&app=webservices&resource=add_tunnel&key=<ключ пользователя>

 

2.2. Удаление туннеля из пользовательского аккаунта

 

Использует метод HTTP GET. Удаляет указанный пользователем туннель. В ответном сообщении пользователь получает сообщение об успехе операции.

https://vpnki.ru/index.php?option=com_api&format=raw&app=webservices&resource=del_tunnel&tunnel=<имя туннеля>&key=<ключ пользователя>

 

2.3. Старт процесса OpenVPN в пользовательской сети и получение файла настроек .ovpn

 

Использует метод HTTP GET. Запускает процесс OpenVPN, в ответ пользователь получает: имя_файла.ovpn и его содержимое в качестве переменных JSON

https://vpnki.ru/index.php?option=com_api&format=raw&app=webservices&resource=ovpn&action=add&key=<ключ пользователя>

 

2.4. Добавление записи в Публикации URL

 

Использует метод HTTP GET. Добавляет указанное пользователем доменное имя. В ответном сообщении пользователь получает сообщение об успехе операции.

Важно! Перед использованием API пользователь должен согласиться с условиями работы Публикации URL через сайт.

https://vpnki.ru/index.php?option=com_api&format=raw&app=webservices&resource=url&action=add&exname=<внешнее имя>&inip=<внутренний ip>&inport=<внутренний порт>&key=<ключ пользователя>

Где:

exname – внешне имя, которое затем станет часть URL например: demo и полный URL будет https://aivanov78-demo.vpnki.ru

inip – адрес компьютера с web-сервером во внутренней сети

inport – порт компьютера с web-сервером (скорее всего 80)

Важно, настройки будут применены в течении 5 минут после успешного выполнения команды!

 

2.5. Удаление ВСЕХ записей в Публикации URL

 

Использует метод HTTP GET. Удаляет все записи пользователя в Публикации URL. В ответном сообщении пользователь получает сообщение об успехе операции.

https://vpnki.ru/index.php?option=com_api&format=raw&app=webservices&resource=url&action=remove&key=<ключ пользователя>

Важно, настройки будут применены в течении 5 минут после успешного выполнения команды!