Skip to content

Changelog — Public API

Politique : SemVer-style. Les breaking changes déclenchent un bump de /v1/v2. Les ajouts non-breaking (nouveaux endpoints, nouveaux champs optionnels en réponse) sont notés ici sans bump.

v1 (current) — depuis 2026-04-27

v1.0.0 — 2026-04-27

Première publication de la documentation officielle. État de l'API :

Endpoints

  • Meta : /me, /scopes, /health
  • CRM : /clients, /contacts, /websites (CRUD)
  • Ticketing : /tickets (CRUD)
  • Facturation : /invoices, /quotes (lecture + création/MAJ)
  • Planning : /tasks, /events (CRUD)
  • Veille : /watches (CRUD)
  • Webhooks (gestion souscriptions) : /webhooks (CRUD)

Auth

  • Header x-api-key: spk_<48 hex>
  • Hash SHA-256 stocké côté serveur
  • Scopes par ressource + wildcard *
  • IP whitelist optionnelle
  • Expiration optionnelle
  • Plan gate : api_access requis sur le plan d'agence

Rate limiting

  • 60 req/min + 10 000 req/jour par défaut (per-clé)
  • Headers X-RateLimit-* exposés
  • Code 429 RATE_LIMIT_EXCEEDED avec Retry-After

Webhooks émis

  • client.created, client.updated, client.deleted
  • contact.created, contact.updated, contact.deleted
  • website.created, website.updated, website.deleted
  • ticket.*, invoice.*, quote.*, task.*, event.*, watch.*

Roadmap (non-publié)

  • Idempotency-Key : header pour rendre les POST idempotents (UUID v4)
  • Cursor-based pagination : alternative à offset/limit pour les très grosses tables
  • Sparse fieldsets : query param fields=id,name,email pour réduire la payload
  • Bulk endpoints : POST /clients/bulk pour créer N entités en une requête
  • Filtres avancés : opérateurs gte, lte, like sur les query params

StormeoOS API