Tariscope 4.6. Посібник з використання Tariscope API

Вступ

Tariscope API - це спеціальний інтерфейс системи Tariscope 4.6, який дозволяє отримувати та змінювати деякі дані бази даних Tariscope за рахунок виконання HTTP запитів.

Tariscope API призначений для розробників ПЗ, які хочуть поєднати своє ПЗ з системою Tariscope.

Tariscope API може використовуватися користувачами як редакції Provider, так і редакції Enterprise, але в силу того, що не всі функції редакції Provider є у версії Enterprise, відповідно, не всі API методи можуть бути корисні користувачам Tariscope Enterprise.

Які дані можливо отримати (переслати) від (до) Tariscope за допомогою Tariscope API?

1. Параметри абонента. [subscriber.get]
2. Перелік абонентів будь-якої групи. [subscriber.list.department]
3. Перелік абонентів вузла зв’язку. [subscriber.list.node]
4. Оновити параметри абонента. [subscriber.update]
5. Створити нового абонента. [subscriber.create]
6. Додати телефонний номер абоненту [subscriber.dnadd]
7. Отримати зведену інформацію по рахунку абонента за конкретний період. [accounts.summary]
8. Отримати всі нарахування конкретного абонента за вказаний період. [accounts.charges]
9. Занести в базу даних Tariscope інформацію щодо оплат від абонента за надані послуги зв’язку. [accounts.payment]
10. Отримати інформацію з бази даних Tariscope щодо оплат від конкретного абонента за заданий період. [accounts.payments]
11. Отримати всі активні тарифні плани. [tariffs.plans]
12. Отримати параметри всіх або окремих тарифів [tariffs.details]
13. Отримати параметри конкретного тарифу в залежності від часу. [tariffs.time]
14. Отримати перелік активних послуг. [services.list]
15. Отримати поточну версію Tariscope. [tariscope.version]
16. Отримати поточну версію бази даних Tariscope. [tariscope.database]
17. Отримати дату поточної версії системи Tariscope. [tariscope.build]
18. Отримати серійний номер ліцензії на Tariscope. [tariscope.serial]
19. Отримати редакцію системи Tariscope. [tariscope.edition]
20. Отримати загальну інформацію про систему Tariscope. [tariscope.summary]
21. Будь-які дані системи, які містяться в базі даних, можуть бути отримані, змінені або додані за допомогою SQL команд. [sql]

 Наступна сторінка

Зміст "Tariscope 4.6. Посібник з використання Tariscope API"

Tariscope 4.6. Посібник з використання Tariscope API

Приклад використання Tariscope API

Перед виконанням будь-яких АРІ запитів до Tariscope спочатку треба отримати токен, за допомогою якого буде виконуватися авторизація в Tariscope при виконанні API методів.

Отримання токена виконується за допомогою методу api.auth. Строк дії токена 6 годин. Після чого слід отримати новий токен.

Приклад виконання запиту до Tariscope з використанням Tariscope API буде показний за допомогою програми Postman.

Отримання токена

Для виконання будь-яких методів API необхідно авторизуватися в системі. Для цього виконайте метод /api/auth.

Оберіть метод Post, та введіть запит для підключення до комп’ютера, де встановлений Tariscope (малюнок 1).

Малюнок 1

Приклад запиту:

http://localhost:7000/api/auth

localhost використовується тільки у випадку, коли програма, з якої виконується API запит, знаходиться на тому ж сервері, де знаходиться ПЗ Tariscope. В інших випадках використовуйте IP адресу серверу Tariscope.

7000 в цьому прикладі – це IP порт, на якому працює Tariscope. За замовчування при встановленні Tariscope пропонується IP порт 8085.

/api/auth – це метод для авторизації в системі.

Перед відправкою запиту в тілі (Body) запиту слід вибрати row, задати JSON формат та ввести в цьому форматі ім’я API користувача (username) та його пароль (password).

Після цього натисніть на кнопку Send. Якщо всі параметри задані правильно, то ви отримаєте відповідь в JSON форматі, звідки слід копіювати токен (малюнок 2). Копіювати слід тільки значення параметру “token”. 

Малюнок 2

Для виконання всіх інших методів Tariscope API цей токен слід вставити на вкладці Authorization в позицію Token.

  Попередня сторінка    Наступна сторінка

Зміст "Tariscope 4.6. Посібник з використання Tariscope API"

Tariscope 4.6. Посібник з використання Tariscope API

Як працювати з Tariscope API?

По-перше, в системі Tariscope треба створити користувача для роботи з API і надати йому доступ до тих методів API, які йому дозволені.

Для цього в меню Tariscope виберіть Додаткові опції -> Інтеграція. З’явиться сторінка, приклад якої наведений на малюнку 1.

Малюнок 1

Клацніть по кнопці Tariscope API. Відобразиться сторінка, приклад якої наведений на малюнку 2.

Малюнок 2

Ця сторінка має два посилання: Користувачі АРІ і Більше методів.

Користувачі API

Відкривається вкладка, яка дозволяє створити, редагувати або видалити користувача Tariscope API, надати йому доступ до конкретних API методів, скинути пароль. Приклад цієї сторінки наведений на малюнку 3.

Малюнок 3

Для створення нового користувача клацніть по іконці Додати. З’явиться вікно, яке наведено на малюнку 4.

Малюнок 4

У позиції Ім’я користувача введіть ім’я.

За необхідності можете додати будь-який коментар у позиції Опис. Це необов’язкове поле для вводу.

В позиціях Новий пароль та Підтвердіть пароль введіть пароль, з яким цей користувач буде підключатися до системи Tariscope.

Клацніть по кнопці Зберегти.

Для обрання методів API, до яких користувач буде мати доступ, виберіть користувача у таблиці користувачів (малюнок 3), та клацніть по іконці Права на методи на панелі інструментів. З’явиться сторінка Налаштування прав, приклад якої показаний на малюнку 5.

Малюнок 5

За допомогою перемикачів виберіть методи 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

Посилання Більше методів (малюнок 2) відображує вікно, з запитом, що ви можете запропонувати нові методи, які з часом ми зможемо реалізувати.

  Попередня сторінка    Наступна сторінка

Зміст "Tariscope 4.6. Посібник з використання Tariscope API"

Tariscope 4.6. Посібник з використання Tariscope API

Методи Tariscope API

1. subscriber.get

Це GET метод, який використовується для отримання параметрів абонента.

Параметри запиту:

• id – ідентифікатор абонента в Tariscope.
• email – електронна адреса абонента, яка задана в Tariscope.

Для виконання методу достатньо одно із цих параметрів.

Дані, що повертає метод:

• id – ідентифікатор абонента.
• fullname – повна назва абонента.
• street – вулиця.
• House – номер будинку.
• Flat – номер квартири.
• email – електронна адреса.
• description – опис.
• authcode – код авторизації.
• ispublic – ознака, чи відображається абонент в довіднику абонентів.
• abonenttype – тип абоненту.
• code – код ЄДРПОУ.
• zipcode – поштовий індекс.
• personalcode – персональний код.
• contractid – ідентифікатор договору з абонентом.
• information – додаткова інформація по абоненту.
• privilegeinfo – інформація про привілеї.
• area – район.
• contractdate - дата договору.
• building – номер корпусу.
• floornumber – номер поверху.
• accountId – ідентифікатор рахунку абонента.
• gender – стать абонента (для фіз. осіб).
• birthday – дата народження.
• bankaccount – номер банківського рахунку.
• bankmfo – код банку.
• taxcode – податковий номер.
• deliverytype – тип доставки кореспонденції.
• privilegediscount – знижка.

Приклад запиту для отримання параметрів абонента з ID = 2928:

http://localhost:8085/api/subscriber/get/?id=2928

  Попередня сторінка    Наступна сторінка

Зміст "Tariscope 4.6. Посібник з використання Tariscope API"