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 методів. Для доступу до АРІ треба виконати авторизацію за допомогою JSON Web Tokens (JWT). Для цього необхідно в тілі запиту методу auth передати ім’я та пароль користувача. Якщо авторизація пройде успішно, то Tariscope поверне токен, який прив’язаний до IP адреси, з якої виконувався запит. Цей токен є дійсним на протязі 6 годин. При виконанні API запитів підтримуються формати JSON або XML. За замовчуванням використовується JSON формат. Щоб вказати конкретний формат, треба вказати його в запиті.
Приклад для POST запиту: /api/auth/xml
Приклад для GET запиту: /api/subscriber/get/xml/?id=1234
