API токены

API токены позволяют безопасно интегрировать ресурсы AI (контексты, товары, базы знаний, API интеграции) и настройки каналов со сторонними системами. Токен привязан к организации и выдается с конкретными правами (scopes).

Передавайте токен в заголовке:

  • X-Api-Token: tok_xxx
  • Authorization: Bearer tok_xxx

Доступы

ScopeОписание
ai_contextsCRUD контекстов AI оператора и Copilot
ai_products_setsCRUD наборов товаров и товаров внутри них
ai_knowledge_basesCRUD баз знаний и файлов в них
ai_api_integrationsCRUD API интеграций (папки, ручки)
channel_ai_operatorНастройки AI оператора на канале: привязка контекста, товаров, знаний, интеграций

Создание токена

  1. Перейдите в раздел Настройки → API токены.
  2. Нажмите Создать токен, задайте имя и выберите необходимые scopes.
  3. Скопируйте значение сразу после создания, позже оно не отображается.

Практика безопасности

  • Создавайте отдельные токены для каждой интеграции, с минимально необходимыми scope-ами.
  • Передавайте токен только по HTTPS.
  • Храните токены в секретном менеджере.
  • При компрометации отзывайте токен и перевыпускайте новый.

REST API

  • GET /api-tokens — список токенов (UI)
  • POST /api-tokens — создание токена (name, description?, scopes[])
  • DELETE /api-tokens/:id — отзыв токена
  • GET /external/channels — список каналов организации по токену

Документация по ресурсам

Пример запроса

Базовый API URL: https://api.apx.chat/api

const url = "https://api.apx.chat/api/external/channels";

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

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