Référence API v1
Chaque point d'accès de l'API REST avec sa méthode, son chemin et la portée requise, généré à partir du document OpenAPI servi par l'API.
GET https://<workspace>.zmle.com/api/v1/me
Démarrage rapide
- Ouvrez une démo instantanée : un espace de travail avec des données d'exemple
- Dans la démo, allez dans Admin → Intégrations et API et créez une clé
- Appelez GET /api/v1/me avec la clé (ci-dessous) pour voir à quel espace et à quelle personne elle appartient
- Ajoutez un point d'accès webhook et choisissez des événements ; dans une démo, les envois sont journalisés mais jamais envoyés
Document OpenAPI
La spécification complète est publique ; aucune clé n'est nécessaire pour la lire : https://zmle.com/api/v1/openapi.json
curl https://<your-demo>.zmle.com/api/v1/me \ -H "Authorization: Bearer $ZMLE_API_KEY"
Adresse de base
Chaque espace de travail répond à sa propre adresse : https://<workspace>.zmle.com/api/v1 (ou son propre domaine). L'hôte API https://api.zmle.com/v1 retrouve l'espace à partir de la clé.
Authentification
Envoyez la clé dans Authorization: Bearer <key> (ou X-Api-Key). Les applications natives et connectées utilisent OAuth 2.1 avec PKCE et des jetons d'application de courte durée.
Listes et pagination
Les listes acceptent page et per (1 à 100, 25 par défaut), q pour la recherche et since pour les changements après une date. La réponse contient total et pages, plus les en-têtes Link et X-Total-Count.
Erreurs
Les erreurs sont en JSON : { error: { code, message } } avec le statut HTTP. Chaque réponse a un X-Request-Id. Les requêtes POST acceptent un en-tête Idempotency-Key. Chaque clé dispose d'un quota de 300 requêtes rechargé à 5 par seconde ; X-RateLimit-Remaining indique le reste, et 429 arrive avec Retry-After.
Versions et dépréciation
La v1 ne fait que grandir : de nouvelles routes et de nouveaux champs s'ajoutent, rien n'est supprimé ni renommé dans la v1. Une route appelée à disparaître est marquée dépréciée au moins 12 mois avant son arrêt ; d'ici là elle fonctionne sans changement et répond avec les en-têtes Deprecation et Sunset.
Client TypeScript
Un client TypeScript officiel généré à partir du document OpenAPI est en préparation (méthodes typées, nouvelles tentatives avec Retry-After, clés d'idempotence, pagination). En attendant sa publication, tout générateur OpenAPI fonctionne avec openapi.json.
Codes d'erreur
| Statut | Code | Signification |
|---|---|---|
400 | invalid_json | Le corps n'est pas un JSON valide |
401 | unauthenticated | Aucune clé ni jeton n'a été envoyé |
401 | invalid_key | La clé est inconnue, révoquée ou expirée, ou un jeton MCP a été utilisé sur l'API REST |
401 | token_expired | Le jeton d'application a expiré : renouvelez-le |
403 | insufficient_scope | La clé n'a pas le droit requis par cette route |
403 | forbidden | La personne de la clé ne peut pas ouvrir cet espace ou cette fiche |
403 | origin_not_allowed | Appel navigateur depuis un site absent des origines autorisées de l'espace |
403 | ip_not_allowed | La liste d'adresses IP autorisées de la clé ne contient pas cette adresse |
403 | test_mode_read_only | Une clé de test a tenté de modifier des données : les clés de test lisent seulement |
404 | not_found | Fiche ou route inexistante dans cet espace de travail |
409 | conflict | La requête entre en conflit avec l'état actuel, par exemple un doublon |
422 | validation_failed | Des champs sont invalides ; la réponse liste les problèmes par champ |
429 | rate_limited | Trop de requêtes : attendez le nombre de secondes indiqué par Retry-After |
500 | internal_error | Une erreur s'est produite de notre côté : réessayez plus tard et citez le X-Request-Id si vous nous contactez |
La référence ci-dessous est en anglais, comme le document OpenAPI.
Customers
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/customers | customers:read | List customers |
GET | /api/v1/customers/{id} | customers:read | Read a customer |
POST | /api/v1/customers | customers:write | Create a customer (an existing e-mail / phone returns that customer) |
PATCH | /api/v1/customers/{id} | customers:write | Update a customer's contact details |
Leads
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/inquiries | inquiries:read | List leads |
GET | /api/v1/inquiries/{id} | inquiries:read | Read a lead |
POST | /api/v1/inquiries | inquiries:write | Create a lead (contact, quote request, booking request, call-back) — notifies the team like the website form |
Quotations
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/quotations | quotations:read | List quotations |
GET | /api/v1/quotations/{id} | quotations:read | Read a quotation with its lines |
POST | /api/v1/quotations | quotations:write | Create a DRAFT quotation (tax computed by the workspace's rules) |
Invoices
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/invoices | invoices:read | List invoices |
GET | /api/v1/invoices/{id} | invoices:read | Read an invoice with lines and payments |
POST | /api/v1/invoices | invoices:write | Create a DRAFT invoice (numbered when issued in the back office) |
GET | /api/v1/payments | payments:read | List invoice payments (invoice=<id> to filter) |
GET | /api/v1/payments/{id} | payments:read | Read a payment |
Orders
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/orders | orders:read | List shop orders |
GET | /api/v1/orders/{id} | orders:read | Read a shop order |
Catalog
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/products | products:read | List products with price and stock (catalog:read also allows it) |
GET | /api/v1/products/{id} | products:read | Read a product |
GET | /api/v1/categories | catalog:read | List categories (type=product|service|post|project, locale=…) (espaces hébergés) |
GET | /api/v1/services | catalog:read | List published services (espaces hébergés) |
GET | /api/v1/services/{id} | catalog:read | Read a service (espaces hébergés) |
GET | /api/v1/products/lookup | products:read | Exact barcode / SKU match (GTIN, SKU or an extra product barcode) — for scanners |
Bookings
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/booking-services | catalog:read | List bookable services (online booking on) (espaces hébergés) |
GET | /api/v1/booking-services/{id} | catalog:read | Read a bookable service (espaces hébergés) |
GET | /api/v1/bookings/slots | bookings:read | Free start times of a bookable service on a date (espaces hébergés) |
GET | /api/v1/bookings | bookings:read | List appointments (espaces hébergés) |
GET | /api/v1/bookings/{id} | bookings:read | Read an appointment (espaces hébergés) |
POST | /api/v1/bookings | bookings:write | Book an appointment at a free time (409 when it was taken) (espaces hébergés) |
Webhooks
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/events | webhooks:read | The webhook event catalog |
GET | /api/v1/deliveries | webhooks:read | Webhook delivery log |
GET | /api/v1/deliveries/{id} | webhooks:read | One delivery with its payload |
GET | /api/v1/webhooks | webhooks:read | List webhook endpoints (no secrets) (espaces hébergés) |
POST | /api/v1/webhooks | webhooks:write | Create a webhook endpoint — the signing secret is returned once (espaces hébergés) |
DELETE | /api/v1/webhooks/{id} | webhooks:write | Delete a webhook endpoint (espaces hébergés) |
Account
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/me | (any) | Who is calling: the API key, or the person signed in to the app, with the workspace and the scopes |
Stock
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/warehouses | stock:read | Active stock locations |
GET | /api/v1/stock | stock:read | Stock levels per location (product=<id> for one product, all its rows) |
POST | /api/v1/stock/adjustments | stock:write | Add or remove stock (same rules as the admin: write-off reasons only remove) |
Appointments
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/appointments | appointments:read | List appointments (from / to filter the start time) |
GET | /api/v1/appointments/{id} | appointments:read | Read an appointment |
Point of sale
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/pos-sales | pos:read | List till sales and refunds (since = created since) |
GET | /api/v1/pos-sales/{id} | pos:read | Read a till sale with its lines and payments |
Tasks
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
GET | /api/v1/tasks | tasks:read | List tasks (app sign-in without tasks.manage: only my tasks) |
GET | /api/v1/tasks/{id} | tasks:read | Read a task |
POST | /api/v1/tasks | tasks:write | Create a task (assigned to the signed-in person by default) |
PATCH | /api/v1/tasks/{id} | tasks:write | Update a task or change its status (DONE closes it; recurring tasks schedule the next one) |
Files
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
POST | /api/v1/attachments | attachments:write | Upload a photo or PDF (multipart: file, taskId?, folder?) — images are re-encoded, metadata such as GPS removed |
GET | /api/v1/attachments/{id} | attachments:write | Read an uploaded file's record |
Apps
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
POST | /api/v1/session/handoff | (app) | One-time URL (60 s) that signs the app's web view in to the workspace and opens `next` (jeton d'application uniquement) |
GET | /api/v1/devices | (app) | My app installations (jeton d'application uniquement) |
POST | /api/v1/devices | (app) | Register an app installation for push (FCM / APNs / Huawei Push Kit token; the same token again returns the same id) (jeton d'application uniquement) |
DELETE | /api/v1/devices/{id} | (app) | Remove an app installation (jeton d'application uniquement) |
GET | /api/v1/devices/{id} | (app) | One app installation with the alert categories it does not get pushes for (jeton d'application uniquement) |
PATCH | /api/v1/devices/{id} | (app) | Alert categories this installation does not get pushes for (tasks, sales, bookings, messages, stock, system) — they still appear in /notifications (jeton d'application uniquement) |
GET | /api/v1/account/deletion | (app) | Delete account (apps): which path applies — workspace owner closes the workspace, staff ask the administrators, customers use the website — with links and a pending request (jeton d'application uniquement) |
POST | /api/v1/account/deletion | (app) | Delete account (apps): mode request = ask the administrators to delete the staff account and remove the app data; mode app-data = only end every app sign-in and web session and remove devices / push tokens (jeton d'application uniquement) |
POST | /api/v1/session/sign-out-all | (app) | Sign out of all devices: ends every app sign-in and web session of the person and removes their app installations (jeton d'application uniquement) |
GET | /api/v1/rider/today | (app) | Rider mode: which duties I may start (rider = parcels.ride, tech = field.work, driver = fleet.drive), my duty, today's runs, delivery stops and pickups (jeton d'application uniquement) |
POST | /api/v1/rider/duty | (app) | Start duty (returns a duty token that can only post positions / end the duty) or end it; the workspace's live-location setting must be on (jeton d'application uniquement) |
POST | /api/v1/rider/positions | (app) | Post a batch of positions while on duty (app token or the duty token fx_dt_…); only the newest valid point is kept (latest position, no trail) and feeds the recipient ETA and the runs map; a driver's batch also moves their vehicle and, when the workspace keeps one, its short trail (jeton d'application uniquement) |
GET | /api/v1/apps | (app) | Home screen of the apps: the app grid I may open (name, area, icon as SVG nodes, waiting count), the workspace brand and unread alerts (jeton d'application uniquement) |
GET | /api/v1/search | (app) | Search records I may open (customers, invoices, orders, products …), grouped like the admin header search; also suggestion (did you mean), quick (prefilled create links such as a new invoice for a customer) and intent (jeton d'application uniquement) |
GET | /api/v1/notifications | (app) | Alerts for me since a time (the desktop app polls this) (jeton d'application uniquement) |
Sensors
| Méthode | Chemin | Portée | Ce qu'il fait |
|---|---|---|---|
POST | /api/v1/sensors/readings | sensors:write | Upload sensor readings (temperature, humidity, fuel_level, value) — up to 500 per request; the device is the key's own device or the serial in `device`; re-sent readings are skipped; send an Idempotency-Key |
Suivant: Webhooks
Les événements métier envoyés à votre point d'accès HTTPS, signés, réessayés et journalisés.