В кабінеті компанії є можливість управляти токенами самостійно. Для установки необхідно перейти у Налаштування - Управління API-токенами.
Розділ і функціонал доступний для власника компанії та ролі Адміністратор.
Якщо у компанії вже є ключі — вони будуть відображатися в цьому розділі із зазначенням прав і терміном дії.
Створення токенів
Кнопка «Створити токен» генерує токен з заданими параметрами.
- Поле «Назва» (Назва може містити літери, цифри і символи ''-). Для створення токена назву вказувати не обов'язково, тоді токен буде створено з автоматичною назвою. Наприклад: Ключ 12334567.
- Поле «Дійсний до» (максимально можливий термін - 1 рік, мінімально - 1 день).
- Дропдаун з налаштуванням доступу (тільки читання/читання та запис/немає доступу) під кожен набір методів.
В публічному API є 7 методів, які налаштовуються в кабінеті:
|
Доступні методи API |
Де налаштовувати права доступу |
|
Orders |
Замовлення і повідомлення |
|
Products |
Продукти та групи |
|
Groups |
Продукти та групи |
|
Clients |
Клієнти |
|
Messages |
Замовлення і повідомлення |
|
Delivery |
Замовлення і повідомлення |
|
PaymentOption |
Налаштування |
Зверніть увагу! Принаймны один блок повинен мати відкриті права, або відобразиться помилка:
Права доступу та коди помилок:
- немає доступу — у відповідь на будь-які запити повертається помилка (403 Forbidden);
- тільки читання — у відповідь в GET-запити успіх (200 OK) на POST-запити повертається помилка (403 Forbidden);
- читання і запис — і GET і POST проходять успішно (200 OK).
Якщо у токена закінчився термін дії, повернеться 401 код помилки (401 Not Authenticated).
Можливі дії зі створеним токеном:
- Перегляд. При натисканні відкриється поп-ап з токеном, який можна скопіювати (токен буде збережено в буфері обміну).
- Редагування. При натисканні відкривається поп-ап з полями, які можна редагувати. Всі поля можливо редагувати і зміни застосовуються онлайн після збереження. Можна міняти назву, термін дії (не більше ніж 1 рік від поточної дати змін), права доступу.
- Видалення. Токен можна видалити, але видалення токена відбувається безповоротно. Як тільки ви підтвердите дію видалення токена, він не буде відображатися в кабінеті. А при спробі отримати дані з таким токеном - відобразиться помилка 401 Not Authenticated.
Повідомлення про деактивацію токена
За 30, а також за 7 днів до деактивації токена, в кабінет компанії та пуш-сповіщеннями надсилається повідомлення про швидке закінчення терміну дії токена.
Щоб продовжити роботу з АРІ, поновіть термін дії токена або створіть новий.
