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

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

Все интеграции, взаимодействующие с платформой 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",
  "event_id": "6b6b0a3a-9e5e-4d3a-9f6e-0c6e9ф8b2a11",
  "occurred_at": "2025-10-11T09:21:34Z",
  "connected_integration_id": "abc123",
  "data": {
    "date": "2025-07-18T12:34:56Z"
  }
}

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

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

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

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

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

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

Error

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

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

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