Ключи API и области доступа
Что ключ может читать и записывать и какие ограничения он получает от создавшего его человека.
Authorization: Bearer fx_live_…
Правила для каждого ключа
- Ключ показывается один раз; хранится только его хеш SHA-256
- Ключ охватывает только разделы, которые может открыть его создатель; ключ ко всем разделам — только для владельца пространства
- Ключ работает в пределах филиалов и компаний своего создателя, как этот человек в бэк-офисе; созданные им записи попадают в филиал этого человека
- Когда создатель отключён или удалён, ключ перестаёт работать
- Ключи могут истекать и отзываться в любой момент; каждый запрос есть в журнале запросов
Как узнать ключ
Каждый ключ начинается с fx_live_. Список ключей показывает первые 14 символов, чтобы различать ключи, не видя их целиком.
Если ключ утёк
- Сразу отзовите его в Админка → Интеграции и API; он перестанет работать со следующего запроса
- Создайте новый ключ с теми же областями и обновите свои системы
- Проверьте журнал запросов на незнакомые вызовы
- Если ключ мог записывать, проверьте созданные им записи
Справочник ниже на английском, как и документ OpenAPI.
Области доступа
customers:read | List and read customers |
customers:write | Create customers and update their contact details |
quotations:read | List and read quotations (with items) |
quotations:write | Create draft quotations |
invoices:read | List and read invoices (with items and payments) |
invoices:write | Create draft invoices |
orders:read | List and read shop orders |
inquiries:read | List and read leads |
inquiries:write | Create leads (goes through the same notifications as the website form) |
products:read | List and read products with stock |
webhooks:read | Read the webhook event catalog and delivery log |
payments:read | List and read invoice payments |
stock:read | Read stock locations and stock levels |
stock:write | Add or remove stock (adjustments, write-offs) |
appointments:read | List and read appointments |
pos:read | List and read till sales and refunds |
tasks:read | List and read tasks |
tasks:write | Create tasks and change them (status, due date, priority) |
attachments:write | Upload photos and PDFs (optionally onto a task) |
sensors:write | Upload readings of sensor devices (temperature, humidity, fuel level) — Sensors & cold chain |
catalog:read | Read the catalog: products, product categories, services and bookable services |
bookings:read | Read appointments and free time slots |
bookings:write | Book appointments (same checks as online booking) |
webhooks:write | List, create and delete webhook endpoints |
Далее: Песочница
Попробуйте API в личном демо-пространстве с примерными данными. Ничто из сделанного там не выходит наружу.