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
- Révoquez-la aussitôt dans Admin → Intégrations et API ; elle cesse de fonctionner dès la requête suivante
- Créez une nouvelle clé avec les mêmes droits et mettez vos systèmes à jour
- Cherchez dans le journal des requêtes les appels que vous ne reconnaissez pas
- 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: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 |
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.