Перейти к содержимому
14 дней бесплатно, без карты9 языков176 типов бизнеса · 50 приложений
RU· USD
Попробовать живое демоПопробовать бесплатно

Ключи API и области доступа

Что ключ может читать и записывать и какие ограничения он получает от создавшего его человека.

Authorization: Bearer fx_live_…

Правила для каждого ключа

  • Ключ показывается один раз; хранится только его хеш SHA-256
  • Ключ охватывает только разделы, которые может открыть его создатель; ключ ко всем разделам — только для владельца пространства
  • Ключ работает в пределах филиалов и компаний своего создателя, как этот человек в бэк-офисе; созданные им записи попадают в филиал этого человека
  • Когда создатель отключён или удалён, ключ перестаёт работать
  • Ключи могут истекать и отзываться в любой момент; каждый запрос есть в журнале запросов

Как узнать ключ

Каждый ключ начинается с fx_live_. Список ключей показывает первые 14 символов, чтобы различать ключи, не видя их целиком.

Если ключ утёк

  1. Сразу отзовите его в Админка → Интеграции и API; он перестанет работать со следующего запроса
  2. Создайте новый ключ с теми же областями и обновите свои системы
  3. Проверьте журнал запросов на незнакомые вызовы
  4. Если ключ мог записывать, проверьте созданные им записи

Справочник ниже на английском, как и документ OpenAPI.

Области доступа

customers:readList and read customers
customers:writeCreate customers and update their contact details
quotations:readList and read quotations (with items)
quotations:writeCreate draft quotations
invoices:readList and read invoices (with items and payments)
invoices:writeCreate draft invoices
orders:readList and read shop orders
inquiries:readList and read leads
inquiries:writeCreate leads (goes through the same notifications as the website form)
products:readList and read products with stock
webhooks:readRead the webhook event catalog and delivery log
payments:readList and read invoice payments
stock:readRead stock locations and stock levels
stock:writeAdd or remove stock (adjustments, write-offs)
appointments:readList and read appointments
pos:readList and read till sales and refunds
tasks:readList and read tasks
tasks:writeCreate tasks and change them (status, due date, priority)
attachments:writeUpload photos and PDFs (optionally onto a task)
sensors:writeUpload readings of sensor devices (temperature, humidity, fuel level) — Sensors & cold chain
catalog:readRead the catalog: products, product categories, services and bookable services
bookings:readRead appointments and free time slots
bookings:writeBook appointments (same checks as online booking)
webhooks:writeList, create and delete webhook endpoints

Далее: Песочница

Попробуйте API в личном демо-пространстве с примерными данными. Ничто из сделанного там не выходит наружу.

Песочница