Перейти к содержимому

Авторизация и права доступа

Как передавать ключ

Отдельного эндпоинта «получить токен» нет. Ключ создаётся в панели управления и передаётся в каждом запросе.

http
Authorization: Bearer {identifier}:{secret}

Пример:

http
Authorization: Bearer pp_abc123:s3cr3tValue

Ключи и роли: Система → Настройка API.

Для CRM обычно достаточно роли с orders.* (чтение, статусы, meta) и при необходимости users.* / documents.*. Не выдавайте «все права», если интеграция только читает заказы.

Ошибки доступа

HTTPТело (типично)Причина
401{"message":"Unauthorized"}Нет заголовка, неверный формат, неверный секрет
403{"message":"Forbidden"}Ключ есть, но нет нужного права
403Заказ/данные чужой точки при привязке ключа к точке

Привязка к точке выдачи

У ключа можно указать точку выдачи. Тогда:

  • списки заказов ограничены этой точкой;
  • запрос с чужим pickup_point_id403;
  • чужой заказ по id → 403 / 404.

Без привязки ключ видит все точки (в рамках прав). Для одной точки продаж / одного филиала в CRM удобно привязать ключ к точке.

Права роли

Права задаются в Роли API. Ниже — полный список, как в системе.

Заказы

ПравоДоступ
orders.readСписок и карточка заказа, позиция
orders.writeСоздание и PATCH полей заказа
orders.write_statusСтатус заказа и позиций
orders.write_metaMeta заказа (ID сделки CRM и т.п.)
orders.deleteУдаление заказа
orders.archive / orders.unarchiveАрхив заказа
orders.read_archivedАрхивные заказы в списках
order_items.archive / order_items.unarchiveАрхив позиций
order_items.writeСоздание и изменение позиций
order_items.deleteУдаление позиций

Справочник статусов

ПравоДоступ
statuses.readGET /statuses/orders и GET /statuses/order-items

Пользователи и организации

ПравоДоступ
users.read / users.write / users.write_meta / users.deleteПользователи
organizations.readОрганизации (только чтение)

Платежи и документы

ПравоДоступ
payments.read / payments.write / payments.deleteПлатежи
documents.readСписок документов
documents.write_external_refВнешний ID документа

Каталог и прайсы

ПравоДоступ
products.read / products.write / products.deleteТовары
categories.write / categories.deleteКатегории
stocks.writeОстатки и цены
price_lists.writeЗагрузка прайса и статус задачи
pricing.readПроценка

Справочники и модули

ПравоДоступ
modules.readСпособы оплаты и доставки
pickup_points.readТочки выдачи
integrations.trigger_syncЗапуск sync модуля интеграции

Webhooks модулей

Исходящие и входящие webhooks модулей (PlanFix и др.) используют отдельные секреты и подписи. Это не Bearer-ключ REST.

Подробнее: Платформа интеграций.

Дальше

База знаний для EMS-платформы PlatParts.