Mga API key at scope
Ano ang puwedeng basahin at isulat ng isang key, at ang mga limitasyong dala nito mula sa taong gumawa nito.
Authorization: Bearer fx_live_…
Mga patakarang sinusunod ng bawat key
- Minsan lang ipinapakita ang key; ang SHA-256 hash lang nito ang itinatago
- Sakop lang ng key ang mga bahaging mabubuksan ng gumawa nito; para sa may-ari ng workspace lang ang key ng lahat ng bahagi
- Gumagana ang key sa loob ng mga branch at kumpanya ng gumawa nito, gaya ng taong iyon sa back office; napupunta sa branch ng taong iyon ang mga record na ginagawa nito
- Kapag na-deactivate o nabura ang gumawa, hihinto ang key
- Puwedeng mag-expire ang mga key at puwedeng bawiin anumang oras; nasa request log ang bawat request
Pagkilala sa isang key
Nagsisimula sa fx_live_ ang bawat key. Ipinapakita ng listahan ng key ang unang 14 character nito, para makilala ang mga key nang hindi nakikita ang buong key.
Kung tumagas ang isang key
- I-revoke agad sa Admin → Integrations & API; titigil ito sa susunod na request
- Gumawa ng bagong key na may parehong scope at i-update ang mga system mo
- Tingnan sa request log ang mga call na hindi mo kilala
- Kung kayang magsulat ng key, suriin ang mga record na ginawa nito
Nasa English ang reference sa ibaba, gaya ng OpenAPI document.
Mga scope
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 |
Susunod: Sandbox workspace
Subukan ang API sa isang personal na demo workspace na may sample data. Walang nararating sa labas ang anumang gagawin mo roon.