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"
