Огляд модуля

Модуль API Синхронізації - це всебічне рішення, що забезпечує безшовну двонаправлену інтеграцію даних між Odoo та зовнішніми системами через RESTful API. Цей корпоративний модуль пропонує розширені опції конфігурації для практично будь-якого сценарію інтеграції.

Основні функції

Двонаправлена синхронізація

• Вхідна обробка – Отримання даних із зовнішніх систем до Odoo
• Вихідна обробка – Відправка даних Odoo до зовнішніх систем

Режими інтеграції

• Інтеграція в реальному часі – Синхронізація даних миттєво при виникненні змін
• Заплановані операції – Автоматична синхронізація через cron завдання

Підтримка автентифікації

• Без автентифікації – Для публічних або внутрішніх API
• Базова автентифікація – Доступ за ім'ям користувача та паролем
• Bearer Token – Автентифікація за API ключем або токеном
• Користувацькі заголовки – Додаткові заголовки автентифікації

Підтримка протоколу HTTP

• Повна підтримка REST – методи GET, POST, PUT та DELETE
• Користувацькі ендпоінти – Конфігуровані визначення API ендпоінтів
• Обробка параметрів – URL параметри та рядки запитів
• Управління заголовками – Конфігурація користувацьких HTTP заголовків

Трансформація даних

• Мапування полів – Візуальне вирівнювання між полями Odoo та ключами API
• Python скрипти – Розширені перетворення даних
• Обчислення значень – Кілька методів для обчислення значень
• Реляційні дані – Підтримка Many2one, One2many, Many2many

Інтеграція з автоматизацією

• Cron завдання – Автоматична синхронізація на основі розкладу
• Дії сервера – Ручні тригери через інтерфейс Odoo
• Базова автоматизація – Синхронізація на основі подій
• Конфігурація тригерів – Гнучкі правила синхронізації

Моніторинг та відладка

• Логування запитів – Повний аудит API комунікацій
• Відстеження помилок – Детальні повідомлення про помилки з кодами статусу
• Налаштування продуктивності – Конфігуровані таймаути
• Підтримка відладки – Всебічні журнали усунення несправностей

Посібник швидкого старту

Крок 1: Доступ до конфігурації

Перейдіть до Налаштування > Технічні > BJ API > Конфігурації API

Крок 2: Створіть конфігурацію

Натисніть Створити та оберіть між:

• Вхідна - Отримання даних із зовнішніх систем
• Вихідна - Відправка даних до зовнішніх систем

Крок 3: Налаштуйте автентифікацію

Виберіть метод автентифікації:

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

Крок 4: Налаштуйте мапування полів

Зіставте поля Odoo з ключами зовнішнього API:

• Виберіть поле Odoo
• Введіть відповідний ключ API
• Оберіть тип обчислення значення
• Позначте одне поле як ідентифікатор запису

Крок 5: Тестування та розгортання

• Збережіть конфігурацію
• Протестуйте на зразках даних
• Моніторте журнали для отримання результатів
• Розгорніть в продакшні

Архітектура модуля

graph TB
    subgraph "Зовнішні системи"
        EXT[Зовнішні API]
    end
    
    subgraph "BJET API Sync Модуль"
        CONFIG[bj.api.sync.config<br/>Основна конфігурація]
        LINE[bj.api.sync.config.line<br/>Мапування полів]
        HEADER[bj.api.sync.header<br/>HTTP заголовки]
        PARAM[bj.api.sync.param<br/>URL параметри]
        LOG[bj.api.log<br/>Аудит трейл]
    end
    
    subgraph "Odoo"
        MODEL[Моделі Odoo]
    end
    
    EXT <-->|REST API| CONFIG
    CONFIG --> LINE
    CONFIG --> HEADER
    CONFIG --> PARAM
    CONFIG --> LOG
    CONFIG <--> MODEL

Компоненти модуля

Шаблон API ендпоінту

Для вхідних конфігурацій ендпоінти слідують цьому шаблону:

/bj_api_sync/v1/<назва_ендпоінту>
/bj_api_sync/v1/<назва_ендпоінту>/<ідентифікатор_запису>

Розділи документації

📚 Посібник з конфігурації
Покрокові посібники для налаштування вхідних та вихідних API

🐍 Python скрипти
Довідник для скриптів трансформації даних та доступних змінних контексту

❓ Усунення несправностей
Поширені проблеми, рішення та найкращі практики

📮 Колекція Postman
Завантажити попередньо налаштовану колекцію для тестування API

Інформація про підтримку

• Веб-сайт: https://register.bjetpro.com/
• Електронна пошта підтримки: support@bjetpro.com
• Комерційна підтримка: Доступна для корпоративних впроваджень
• Залежності: bj_api_log, base_automation

Для детальних інструкцій з конфігурації, будь ласка, зверніться до Посібника з конфігурації.