Перейти до основного вмісту

Огляд конфігурації

Для налаштування синхронізації API необхідно створити запис конфігурації API синхронізації (bj.api.sync.config).

Типи конфігурацій​

Модуль API синхронізації підтримує два основні типи конфігурацій:

Вхідна конфігурація​

Отримання даних із зовнішніх систем до Odoo. Зовнішні API можуть надсилати дані до вашого екземпляра Odoo через стандартизовані ендпоінти.

Випадки використання:

  • Отримання замовлень з платформ електронної комерції
  • Імпорт даних клієнтів із CRM систем
  • Синхронізація інвентаря з систем управління складом
  • Синхронізація іншої системи або двох різних інстансів Odoo

Вихідна конфігурація​

Відправка даних Odoo до зовнішніх систем. Автоматичне передавання даних з Odoo до зовнішніх API на основі тригерів та подій.

Випадки використання:

  • Відправка рахунків до облікових систем
  • Оновлення каталогів товарів на сайтах електронної комерції
  • Синхронізація даних клієнтів з маркетинговими платформами
  • Синхронізація іншої системи або двох різних інстансів Odoo

Основні компоненти конфігурації​

1. Загальна конфігурація​

  • Назва – описовий заголовок для конфігурації
  • Тип запиту – визначає напрямок синхронізації (Вхідний/Вихідний)
  • Модель – модель Odoo для синхронізації
  • Домен фільтру – умови для фільтрації записів для синхронізації
  • URL – базовий URL зовнішнього API
  • Ендпоінт – специфічний ендпоінт API (використовується у вхідних запитах)
  • HTTP методи – дозволені операції (GET, POST, PUT, DELETE)

2. Автентифікація​

Оберіть один з кількох методів автентифікації:

  • Без автентифікації
  • Базова автентифікація (ім'я користувача/пароль)
  • Bearer Token (API ключ)
  • Власні заголовки

3. Мапування даних​

Рядки конфігурації (bj.api.sync.config.line) визначають мапування полів:

  • Поле – поле Odoo для мапування
  • Ключ зовнішнього API – відповідний ключ у зовнішньому API
  • Ідентифікатор запису – позначає унікальний ідентифікатор
  • Тип обчислення значення – метод для обчислення значень полів

4. Розширені опції​

  • Налаштування тайм-ауту – тайм-аути з'єднання та читання
  • Заголовки – власні HTTP заголовки
  • Параметри – параметри URL для GET запитів
  • Python скрипти – власні трансформації даних

Моделі конфігурації​

Модуль використовує кілька моделей для управління конфігураціями:

МодельПризначення
bj.api.sync.configОсновна конфігурація синхронізації
bj.api.sync.config.lineМапування поле-до-ключ API
bj.api.sync.headerВласні HTTP заголовки
bj.api.sync.paramURL параметри
bj.api.logАудиторський слід запит/відповідь

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