Skip to content

Документация Sync-Numbers

🚀 REST API шлюз для интеграции передачи контактов с AI

Безопасный, готовый к production сервис на FastAPI для бесшовной синхронизации контактов с AI

🌟 Что такое Sync-Numbers?

Sync-Numbers — это надёжный API шлюз, который связывает ваши системы с нашими ИИ моделями, предоставляя корпоративный уровень возможностей передачи контактов со встроенной валидацией, идемпотентностью и наблюдаемостью.

Ключевые возможности

✅ Валидация и нормализация телефонов - Валидирует и нормализует номера в формат E.164
✅ Идемпотентность - Предотвращает повторную обработку с TTL 72 часа
✅ Аутентификация - Bearer токен + опциональные HMAC подписи
✅ Автоматическое разбиение - Разделяет большие пакеты (макс. 1000 контактов на чанк)
✅ Умная логика повторов - Экспоненциальная отсрочка для ошибок 429/5xx
✅ Режим тестирования - Проверка валидации без отправки данных
✅ Полная наблюдаемость - Структурированные логи, метрики Prometheus, correlation ID
✅ Безопасность превыше всего - Маскирование PII, белые списки IP, только HTTPS

📚 Документация

  • Справочник API

    Полная документация API с аутентификацией, эндпоинтами и примерами

    Руководство по API

  • Примеры кода

    Практические примеры на Python, JavaScript и cURL

    Примеры

🚀 Быстрый пример

import httpx
import uuid

async def import_contacts():
    headers = {
        "Authorization": "Bearer demo_api_key_12345",
        "Idempotency-Key": str(uuid.uuid4()),
        "Content-Type": "application/json",
    }

    contacts = [{
        "phone": "+79001234567",
        "tags": ["лид", "сайт"],
        "additionalFields": {
            "source": "landing",
            "campaign": "summer2024"
        }
    }]

    async with httpx.AsyncClient() as client:
        response = await client.post(
            "https://import-api.liddex.ru/v1/contacts/import",
            json=contacts,
            headers=headers,
        )
        return response.json()

🏗️ Архитектура

graph LR
    A[Партнёрская система] -->|HTTPS/JSON| B[Sync API]
    B -->|HTTPS/JSON| C[AI Webhook]
    B -->|Хранение| D[(PostgreSQL)]
    style B fill:#4051b5,stroke:#fff,color:#fff

📖 Доступные языки

Эта документация доступна на нескольких языках:

🔗 Полезные ссылки

🆘 Поддержка

Нужна помощь? Вот как получить поддержку:

  1. Проверьте Руководство по API для частых проблем
  2. Изучите Руководство по интеграции для технических деталей
  3. Включайте correlation_id при сообщении о проблемах
  4. Свяжитесь с вашей командой поддержки интеграции

Сделано с ❤️ для бесшовной интеграции передачи контактов