Clomni

Платформа для разработчиков: что это и какой способ выбрать

Обновлено: 11 ноября 2026 · 6 мин чтения

Платформа для разработчиков Clomni (developer.clomni.ai) нужна, чтобы соединить собственные программы Вашей компании с Clomni: CRM записывает нового клиента в Clomni, Ваша панель показывает диалоги, система заказов отправляет клиенту сообщение в WhatsApp, BI-инструмент забирает цифры. Соединение строится через API. API это правила, по которым программы общаются друг с другом: Ваша программа отправляет запрос в Clomni через интернет, Clomni возвращает ответ. Код пишет Ваш программист, Ваша задача: выбрать способ и подтвердить разрешения.

Шаги

  1. 1

    Основные понятия

    • Токен: секретный ключ, которым программа представляется, когда отправляет запрос в Clomni. Это как пароль, его никому не передают.
    • Scope: разрешение, которое говорит, что может делать токен, например contacts:read нужен для чтения контактов.
    • Эндпоинт (endpoint): один адрес и одна операция API, например GET /v1/conversations возвращает список диалогов.
    • Вебхук (webhook): сообщение, которое Clomni сам отправляет на Ваш сервер, когда в Clomni происходит событие (новое сообщение, новый контакт).
    • OAuth: порядок, при котором администратор другой компании подключает свой аккаунт к Вашему приложению без передачи пароля: он нажимает «Allow» на экране согласия.
    • Review (проверка): сотрудник Clomni проверяет scope, которые запрашивает приложение, и одобряет их.
  2. 2

    Способ 1: личный ключ API

    Фото профиля › «Profile Settings › API access» › «New key». Ключ работает от Вашего имени и с Вашими правами, scope и review нет, ключ работает сразу. Запрос идёт с заголовком Authorization: Bearer <API_KEY>, в адресе есть номер аккаунта: https://api.clomni.ai/v1/accounts/{account_id}/whatsapp/.... Этот ключ работает только с WhatsApp API (шаблоны, сообщения, статусы). Для других данных, например разговоров, контактов или отчётов, нужно приложение разработчика (путь 2 или 3). Подходит для отправки OTP и уведомлений в WhatsApp с Вашего сайта или из CRM. Ключ даёт широкий доступ, и когда сотрудник, который его создал, уходит из компании, интеграция останавливается. Шаги: статья «Как создать ключ API (API access)».

  3. 3

    Способ 2: внутреннее приложение

    Создаётся на developer.clomni.ai кнопкой «New app» для Вашего workspace, создать его может только администратор этого workspace. Вы выбираете нужные scope, Clomni их проверяет, токен работает только с одобренными scope. Есть личный токен (clomni_pat_, 30-365 дней) и токен приложения на 1 час (clomni_at_), который сервер получает сам. В комплекте подписанные вебхуки, синхронизация, лента событий, экспорт и тестовый канал. В адресе нет номера workspace: https://api.clomni.ai/v1/conversations. Подходит для постоянной интеграции, такой как CRM, ERP, своя панель, BI.

  4. 4

    Способ 3: публичное приложение (public app)

    Приложение, которое подключают другие аккаунты Clomni. Администратор каждого workspace читает разрешения на экране согласия, нажимает «Allow», и для этого workspace создаётся отдельный токен (OAuth). Каждый scope проходит review, в том числе scope с низким риском. Когда листинг отдельно одобрен, приложение появляется в каталоге на странице «Apps» в панели. Выберите этот способ, если предлагаете свой продукт многим клиентам Clomni. Подробнее: статья «Public app и OAuth: как другие аккаунты подключают приложение».

  5. 5

    Выбор по задаче

    • Отправлять с сайта OTP или уведомления о заказе, начать быстро: личный ключ API и WhatsApp API (статья «Начало работы с WhatsApp API: ключ API, account_id и channel_id»).
    • Контакты CRM синхронизируются с Clomni: внутреннее приложение, набор «CRM sync» (синхронизация с CRM).
    • Диалоги Clomni и ответы в нашей панели: внутреннее приложение, набор «Clomni in my own panel» (Clomni в моей панели).
    • Цифры уходят в Power BI, Looker и другие инструменты: внутреннее приложение, набор «BI and reporting» (BI и отчёты).
    • Один раз перенести всю историю: внутреннее приложение, набор «Data export» (экспорт данных).
    • Предложить наш продукт всем клиентам Clomni: публичное приложение.
    • Подключить готовое приложение без кода: «Settings › Workspace settings › Apps» (статья «Страница Apps в панели: подключение приложения, разрешения и отключение»).

    Какие scope нужны, объясняет статья «Какие scope нужны: scope и endpoint по Вашей задаче».

  6. 6

    С чего начать

    1. Выберите способ. Если это готовое приложение, перейдите на страницу «Apps» в панели.
    2. Если это Ваша собственная интеграция, создайте приложение по статье «Создание приложения на developer.clomni.ai: пошагово» и запросите scope.
    3. Пока ждёте review, проверяйте приложение в тестовом канале (статья «Тестовый канал: проверка приложения без реальных клиентов»).
    4. Создайте токен и передайте программисту полное руководство (PDF): там все шаги, примеры кода и коды ошибок.

    По вопросам пишите на [email protected], по безопасности на [email protected].

Документ

Платформа для разработчиков: руководство v1.0 · 41 стр. Открыть Скачать