Integ Docs | API

Appearance

Интеграции ​

Документация по настройке и использованию интеграций с внешними сервисами.

Обзор ​

Integ API позволяет подключать различные внешние сервисы через единый интерфейс. Каждая интеграция включает:

  • Конфигурацию - настройки подключения
  • Секреты - API ключи и токены
  • Handlers - обработчики событий и действий

Доступные интеграции ​

ИнтеграцияСтатусОписание
Telegram✅ ReadyМессенджер и боты
Slack🚧 WIPКорпоративный мессенджер
WhatsApp📋 PlannedМессенджер

Добавление новой интеграции

Используйте шаблон документации для создания документации новой интеграции.

Общая архитектура ​

mermaid
graph TB
    subgraph "Ваше приложение"
        App[Application]
    end

    subgraph "Integ Platform"
        API[Integ API]
        Gateway[Gateway API]
        Secrets[Secrets Storage]
    end

    subgraph "Внешние сервисы"
        Telegram[Telegram API]
        Slack[Slack API]
        WhatsApp[WhatsApp API]
    end

    App -->|REST API| API
    API -->|Fetch secrets| Secrets
    API -->|Forward request| Gateway
    Gateway --> Telegram
    Gateway --> Slack
    Gateway --> WhatsApp

Быстрый старт ​

1. Создание интеграции ​

bash
curl -X POST http://localhost:3000/api/integrations \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-telegram"}'

2. Добавление секретов ​

bash
curl -X POST http://localhost:3000/api/secrets \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "integration": "my-telegram",
    "key": "bot_token",
    "value": "123456:ABC-DEF..."
  }'

3. Создание handler ​

bash
curl -X POST http://localhost:3000/api/handlers \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "integrationId": "integration-uuid",
    "name": "send-message",
    "defaultArgs": {"retries": 3}
  }'

4. Вызов handler ​

bash
curl -X POST http://localhost:3000/api/handlers/handler-uuid/invoke \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "args": {
      "chat_id": "123456789",
      "text": "Hello!"
    }
  }'

Структура документации интеграции ​

Каждая интеграция документируется по стандартному шаблону:

  1. Быстрый старт - минимальный рабочий пример
  2. Обзор - возможности и архитектура
  3. Требования - что нужно для работы
  4. Установка - пошаговая настройка
  5. Конфигурация - параметры и переменные
  6. API Reference - доступные методы
  7. Примеры - практическое использование
  8. Troubleshooting - решение проблем

Связанные документы ​