Tariscope 4.6. Руководство пользователя
4. Tariscope API
Биллинговая система Tariscope имеет несколько возможностей для взаимодействия с другими информационными системами пользователя:
- Гостиничные системы. В пределах этого интерфейса может выполняться взаимодействие не только с гостиничными системами, но и с любыми другими с помощью специально разработанного сценария. Список данных, которые могут передаваться, определяется возможностями сценария. Обычно передается информация по текущему выполненному вызову.
- Доступ к базе данных Tariscope. Администратор Tariscope может предоставить другим пользователям непосредственный доступ к базе данных Tariscope. В этом случае можно предоставить доступ как ко всей базе данных, так и к отдельным ее частям.
- Tariscope API. Это специальный интерфейс Tariscope, который позволяет получать и изменять некоторые данные базы данных Tariscope за счет выполнения HTTP вызовов.
В этой статье мы рассмотрим последний вариант, а именно получение данных с помощью Tariscope API.
Какие данные можно получить (переслать) от (в) Tariscope с помощью Tariscope API?
- Параметры абонента. [subscriber.get]
- Перечень абонентов любой группы. [subscriber.list.department]
- Перечень абонентов узла связи. [subscriber.list.node]
- Обновить параметры абонента. [subscriber.update]
- Сводную информацию по счету абонента за конкретный период. [account.summary]
- Текущую версию Tariscope. [tariscope.version]
- Текущую версию базы данных Tariscope. [tariscope.database]
- Дату текущей версии системы Tariscope. [tariscope.build]
- Серийный номер лицензии на Tariscope. [tariscope.serial]
- Редакцию системы Tariscope. [tariscope.edition]
- Общую информацию о системе Tariscope. [tariscope.summary]
- Перечень доступных методов API для конкретного пользователя. [claims]
- Какие-угодно данные системы могут быть получены, изменены или добавлены с помощью SQL команд. [sql]
Как работать с Tariscope API?
В меню Tariscope выберите Интеграция. Появится соответствующая страница, пример которой показан на рисунке 1.
Рисунок 1
Щелкните по кнопке Tariscope API. Отобразится соответствующая страница, пример которой показан на рисунке 2.
Рисунок 2
Эта страница имеет две вкладки.
Документация. Отображаются ссылки на все API методы, которые поддерживаются. Переход по каждой из ссылок позволяет получить информацию по конкретному методу. Пример этого для метода subscriber.get показан на рисунке 3.
Рисунок 3
Пользователи API. Эта вкладка позволяет создать, редактировать или удалить пользователя Tariscope API, предоставить ему доступ к конкретным методам, сбросить пароль. Пример этой страницы показан на рисунке 4.
Рисунок 4
Для создания нового пользователя щелкните по иконке Добавить. Появится окно, которое показано на рисунке 5.
Рисунок 5
В позиции Имя пользователя введите имя.
При необходимости можете добавить какой-нибудь комментарий в позиции Описание. Это необязательное поле для ввода.
В позициях Новый пароль и Подтвердите пароль введите пароль, з которым этот пользователь будет подключаться к системе Tariscope.
Щелкните по кнопке Сохранить.
Для выбора методов API, к которым пользователь будет иметь доступ, выберите пользователя в таблице пользователей (рисунок 4) и щелкните по иконке Права на методы на панели инструментов. Появится страница Настройки прав, пример которой показан на рисунке 6.
Рисунок 6
С помощью переключателей выберите методы API, к которым пользователь будет иметь доступ. Щелкните по кнопке Сохранить. На этом настройка доступа к методам API со стороны системы Tariscope завершена.
Далее вы должны написать код для выполнения методов API. Для доступа к API необходимо выполнить авторизацию с помощью JSON Web Tokens (JWT). Для этого необходимо в теле запроса метода auth передать имя пользователя и пароль. Если авторизация пройдет успешно, то Tariscope вернет токен, привязанный к IP адресу, с которого выполнялся запрос. Этот токен действителен в течение 6 часов. При выполнении запросов API поддерживаются форматы JSON или XML. По умолчанию используется формат JSON. Чтобы указать конкретный формат, необходимо указать его в запросе.
Пример для POST запроса: /api/auth/xml
Пример для GET запроса: /api/subscriber/get/xml/?id=1234
