В кабінеті компанії Prom.ua є можливість управляти API-токенами самостійно. Для налаштування інтеграції з зовнішніми сервісами або автоматизації бізнес-процесів перейдіть у розділ Налаштування → Управління API-токенами.
Цей функціонал доступний для власника компанії та користувачів з роллю Адміністратор.
Якщо у компанії вже є створені ключі доступу до API Prom.ua — вони будуть відображатися в цьому розділі із зазначенням прав доступу до API та терміну дії токена.
Створення API-токена на Prom
Кнопка «Створити токен» генерує токен із заданими параметрами для інтеграції Prom із CRM, ERP або іншими зовнішніми системами.
-
Назва — може містити літери, цифри та символи (" -). Назву вказувати необов’язково, у цьому випадку система сформує її автоматично, наприклад: Ключ 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 днів до завершення терміну дії, Prom.ua надсилає сповіщення у Кабінет компанії та у вигляді push-повідомлення.
Щоб API Prom.ua продовжував працювати, оновіть термін дії або створіть новий токен.