🔛API-інтеграція JediDesk

Підключіть JediDesk до вашої системи через REST API та отримуйте події в реальному часі через Webhooks.

---

Для чого потрібна API-інтеграція

API дозволяє вашій системі (сайту, CRM, ERP, мобільному додатку) автоматично взаємодіяти з JediDesk:

• Синхронізація клієнтів — передача даних між системами

• Управління замовленнями — створення, оновлення та відстеження

• Робота з діалогами — створення чатів і відправка повідомлень

• AI-запити — використання AI JediDesk у вашому продукті

• Оновлення каталогу — масове оновлення цін і наявності

• Реакція на події — отримання сповіщень через Webhooks

---

Як підключити API

1. Перейдіть у розділ Інтеграції → API в кабінеті JediDesk

2. Натисніть «Згенерувати API-токен»

3. Скопіюйте токен — він використовується для всіх запитів

---

Аутентифікація

Кожен API-запит повинен містити заголовок:

Authorization: Bearer ВАШ_ТОКЕН

Якщо токен відсутній або неправильний — API поверне помилку 401 Unauthorized.

---

Базова інформація

Base URL:

https://app.jedidesk.com/api/v1

---

Основні можливості API

Клієнти Отримання, пошук і оновлення даних (телефон, email, теги, кастомні поля)

Замовлення Створення, оновлення та видалення замовлень

Діалоги Перегляд, створення та отримання історії чатів

Повідомлення Відправка повідомлень у діалоги

AI Запити до AI-асистента на основі бази знань

Товари Масове оновлення цін і залишків

Документація: https://documenter.getpostman.com/view/8460280/2sAYkLoJ2S

---

Webhooks

Webhooks — це автоматичні HTTP-сповіщення про події.

---

Як налаштувати Webhook

1. Перейдіть у Інтеграції → API

2. У блоці Webhooks натисніть «Додати webhook»

3. Вкажіть URL вашого сервера

4. Оберіть події

5. Збережіть

Можна створювати кілька webhook-ів для різних задач.

---

Події Webhook

Клієнти

customer.created — створено нового клієнта customer.updated — оновлено дані клієнта customer.deleted — клієнта видалено

---

Діалоги

chat.created — створено діалог chat.updated — оновлено діалог chat.deleted — діалог видалено

---

Повідомлення

message.created — нове повідомлення message.updated — повідомлення змінено message.deleted — повідомлення видалено

---

AI

ai.func_call — AI викликав функцію

---

Формат Webhook-запиту

JediDesk надсилає POST-запит з JSON:

{
  "event": "message.created",
  "data": {},
  "timestamp": "2024-03-15T10:00:00Z",
  "token": "ваш_api_токен",
  "request_id": "унікальний_id"
}

---

Логування

Усі webhook-запити зберігаються в логах:

• подія

• тіло запиту

• статус відповіді

• відповідь сервера

Доступно в розділі Інтеграції → API.

---

Типові сценарії використання

Інтернет-магазин Передача замовлень у JediDesk та автоматичні повідомлення клієнтам

CRM-система Синхронізація клієнтів і створення лідів через webhook

Мобільний додаток Інтеграція AI-асистента у чат додатку

Автоматизація Використання ai.func_call для запуску бізнес-логіки