Быстрый старт публичного API#

1. Владелец создаёт приложение в настройках ключей, выбирает минимальные scopes. CRM, AI Agents, Booking, Channels и Messaging — разные наборы прав.
2. Сохраните credential на сервере интеграции. Передавайте X-Api-Token или Authorization: Bearer, без cookie кабинета.
3. Откройте OpenAPI текущего стенда, выберите операцию и проверьте её обязательные поля, scopes и ответы.
4. Сначала выполните чтение capabilities нужного домена. Для операций, явно поддерживающих Idempotency-Key в контракте, сохраните новый ключ перед записью; при потере ответа повторяйте прежние payload и ключ. Legacy AI/Channels не обещают идемпотентность: после timeout сначала сверяйте результат чтением и не повторяйте создание автоматически.
5. Обрабатывайте webhook как сигнал обновления: дедупликация по event ID, версия объекта важнее порядка доставки. Сверяйте результат чтением API.

js

APX: X-Api-Token

Скопировать код

const url = "https://api.apx.chat/api/v1/crm/capabilities";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-Api-Token": "tok_xxxxx",
  },
});

const data = await response.json();
console.log(data);

Примеры переключаются между cURL, JavaScript и Python; адрес берётся из текущего окружения. Значения tok_xxxxx и UUID замените своими. Postman каждого домена генерируется из того же OpenAPI в server docs/public-api/v1/ (CRM — docs/crm-api/).

Выберите сценарий#

Общие ошибки и лимиты · Все операции и схемы