Aller au contenu
Essai gratuit de 14 jours, sans carte9 langues176 types d'activité · 50 applications
FR· USD
Essayer une démo en directEssai gratuit

Clés API et portées

Ce qu'une clé peut lire et écrire, et les limites qu'elle tient de la personne qui l'a créée.

Authorization: Bearer fx_live_…

Règles suivies par chaque clé

  • Une clé n'est affichée qu'une fois ; seul son hachage SHA-256 est stocké
  • Une clé ne couvre que les domaines que son créateur peut ouvrir ; la clé « tous domaines » est réservée au propriétaire de l'espace
  • Une clé agit dans les succursales et sociétés de son créateur, comme cette personne dans le back-office ; les enregistrements qu'elle crée vont dans la succursale de cette personne
  • Quand le créateur est désactivé ou supprimé, la clé cesse de fonctionner
  • Les clés peuvent expirer et être révoquées à tout moment ; chaque requête figure dans le journal des requêtes

Reconnaître une clé

Chaque clé commence par fx_live_. La liste des clés montre ses 14 premiers caractères, pour distinguer les clés sans voir la clé entière.

Si une clé fuit

  1. Révoquez-la aussitôt dans Admin → Intégrations et API ; elle cesse de fonctionner dès la requête suivante
  2. Créez une nouvelle clé avec les mêmes droits et mettez vos systèmes à jour
  3. Cherchez dans le journal des requêtes les appels que vous ne reconnaissez pas
  4. Si la clé pouvait écrire, vérifiez les fiches qu'elle a créées

La référence ci-dessous est en anglais, comme le document OpenAPI.

Portées

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

Suivant: Espace de démonstration

Essayez l'API sur un espace de démonstration personnel avec des données d'exemple. Rien de ce que vous y faites n'atteint le monde extérieur.

Espace de démonstration