Методы интеграций

Общая информация

Все интеграции, взаимодействующие с платформой REGOS, могут реализовать ряд базовых методов для обеспечения корректной работы с REGOS: API . Эти методы вызываются платформой для управления подключением, отключением, переподключением интеграции и обработки данных в рамках бизнес-логики. Базовые методы являются необязательными для реализации, но их использование обеспечивает стандартизированное взаимодействие с сервисом.

Например, для SMS-интеграций обязателен метод SendMessages, который отвечает за отправку сообщений через SMS-провайдера. Реализация таких методов позволяет интеграциям выполнять специализированные функции, тесно связанные с бизнес-процессами REGOS.

Поддерживаемые базовые методы

Платформа REGOS поддерживает следующие базовые методы, которые могут быть реализованы в интеграциях:

1. Connect
2. Disconnect
3. Reconnect
4. UpdateSettings
5. HandleWebhook

Порядок взаимодействия

Взаимодействие с интеграциями осуществляется по протоколу HTTP с использованием метода POST. Данные передаются в теле запроса в формате JSON.

• Таймаут выполнения запроса: 30 секунд.
• Особенности реализации:
  • Базовые методы интеграции необязательны для реализации, и REGOS: API не ожидает ответа от них.
  • Методы встраиваемых интеграций обязательны, и от них ожидается корректный ответ.

Заголовки (Headers)

Входные параметры

Пример запроса

{
    "action": "Connect",
    "connected_integration_id": "34r2vt4t5y56456378237eg2d32d5f25",
    "data": {
      "date": "2025-07-18T12:34:56Z"
    }
}

Выходные параметры

Успешное выполнение

Модель тела ответа, в случае успешного выполнения метода:

Пример ответа

Пример тела ответа, в случае успешного выполнения метода:

{
    "ok": true,
    "result": {...}
}

Ошибка при выполнении

Модель тела ответа, в случае логической ошибки при выполнении метода:

Error

Модель, описывающая логическую ошибку при выполнении метода:

Пример ответа

Пример тела ответа, в случае логической ошибки при выполнении метода:

{
    "ok": false,
    "result": {
        "error": 1234,
        "description": "Something went wrong!"
    }
}

Рекомендации по реализации

1. Валидация данных: Перед обработкой запроса проверяйте корректность входных параметров (action, connected_integration_id, data) для предотвращения ошибок.
2. Обработка ошибок: Всегда возвращайте структурированный ответ с полем ok и, при необходимости, моделью ошибки с кодом и описанием.
3. Логирование: Реализуйте логирование входящих запросов и ответов для упрощения отладки.
4. Таймауты: Учитывайте таймаут и оптимизируйте выполнение методов, чтобы избежать превышения этого времени.
5. Безопасность: Проверяйте connected-integration-id в заголовке и теле запроса для обеспечения безопасности интеграции.