API токены

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

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

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

Доступы

ScopeОписание
productsДоступ к API управления товарами (создание, обновление, удаление)
knowledge_baseЗагрузка файлов базы знаний и их переиндексация

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

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

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

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

REST API

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

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

Базовый 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);