Lumaktaw sa nilalaman
14 araw na libreng trial, walang card9 wika176 uri ng negosyo · 50 app
TL· USD
Subukan ang live demoSimulan ang free trial

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

  1. I-revoke agad sa Admin → Integrations & API; titigil ito sa susunod na request
  2. Gumawa ng bagong key na may parehong scope at i-update ang mga system mo
  3. Tingnan sa request log ang mga call na hindi mo kilala
  4. 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: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

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.

Sandbox workspace