Développeur
Référence API
Tout ce dont vous avez besoin pour vous intégrer à NexusKit. Authentification, endpoints, gestion des erreurs et limites de taux — le tout au même endroit.
URL de base
Toutes les requêtes API utilisent l'URL de base suivante :
$https://api.nexus-kit.comTous les endpoints sont versionnés sous /v1/. Les endpoints publics utilisent /v1/public/.
Authentification
NexusKit utilise l'authentification par token Bearer. Incluez votre clé API dans l'en-tête Authorization :
Authorization: Bearer nk_live_abc123def456...Formats de clé API
Les clés API sont scopées par module. Vous pouvez créer des clés en lecture seule ou en lecture-écriture dans le dashboard, sous Développeurs → Clés API.
En-têtes courants
Incluez ces en-têtes avec chaque requête API :
| En-tête | Requis | Description |
|---|---|---|
| Authorization | Oui | Token Bearer — votre clé API préfixée par Bearer |
| X-Tenant-Id | Non | Remplace le contexte de tenant (avancé — par défaut, le tenant propriétaire de la clé) |
| Content-Type | Pour POST/PATCH | À définir sur application/json pour les corps de requête JSON |
Réponses d'erreur
Toutes les réponses API suivent un format d'enveloppe cohérent. Les erreurs incluent un code lisible par machine et un message lisible par l'humain :
{
"data": null,
"meta": {},
"error": {
"code": "VALIDATION_ERROR",
"message": "Email is required",
"details": {
"field": "email",
"reason": "missing_required"
}
}
}| Statut HTTP | Code d'erreur | Description |
|---|---|---|
| 400 | VALIDATION_ERROR | Le corps de la requête a échoué à la validation |
| 401 | UNAUTHORIZED | Clé API manquante ou invalide |
| 403 | FORBIDDEN | La clé API ne dispose pas du scope requis |
| 404 | NOT_FOUND | La ressource n'existe pas |
| 429 | RATE_LIMITED | Trop de requêtes — ralentissez |
| 500 | INTERNAL_ERROR | Une erreur est survenue de notre côté |
Limitation de taux
Pour garder NexusKit rapide et équitable pour tous, toutes les requêtes API sont soumises à une limite de taux :
Lorsque vous atteignez la limite, vous recevrez une réponse 429 Too Many Requests avec un en-tête Retry-After indiquant le nombre de secondes à attendre.
Contact
Capturez des leads depuis des formulaires de site via API. Les soumissions arrivent dans votre dashboard avec notifications email.
| Méthode | Chemin | Auth | Scope | Description |
|---|---|---|---|---|
| GET | /v1/contact/forms | Bearer | contact:read | Liste tous les formulaires de votre tenant |
| POST | /v1/contact/forms | Bearer | contact:write | Crée un nouveau formulaire de contact |
| GET | /v1/contact/forms/:id/submissions | Bearer | contact:read | Liste les soumissions d'un formulaire |
| PATCH | /v1/contact/submissions/:id | Bearer | contact:write | Met à jour le statut ou les notes d'une soumission |
| GET | /v1/contact/export.csv | Bearer | contact:read | Exporte les soumissions en CSV |
| POST | /v1/public/contact/forms/:id/submissions | None | — | Public — soumettre un formulaire depuis votre site |
Réservation
Réservation d'agenda avec services, créneaux de disponibilité et gestion des rendez-vous.
| Méthode | Chemin | Auth | Scope | Description |
|---|---|---|---|---|
| GET | /v1/booking/services | Bearer | booking:read | Liste tous les services de réservation |
| POST | /v1/booking/services | Bearer | booking:write | Crée un nouveau service de réservation |
| POST | /v1/booking/availability | Bearer | booking:write | Interroge les créneaux disponibles |
| GET | /v1/booking/bookings | Bearer | booking:read | Liste toutes les réservations |
| GET | /v1/booking/export.csv | Bearer | booking:read | Exporte les réservations en CSV |
| GET | /v1/public/booking/services | None | — | Public — liste les services pour intégration |
| GET | /v1/public/booking/services/:id/slots | None | — | Public — récupère les créneaux disponibles pour un service |
| POST | /v1/public/booking/bookings | None | — | Public — crée une réservation |
Liens & QR
Liens courts et codes QR imprimables avec statistiques agrégées respectueuses de la vie privée.
| Méthode | Chemin | Auth | Scope | Description |
|---|---|---|---|---|
| GET | /v1/qr/links | Bearer | qr:read | Liste tous les liens courts |
| POST | /v1/qr/links | Bearer | qr:write | Crée un nouveau lien court ou code QR |
| GET | /v1/qr/export.csv | Bearer | qr:read | Exporte les liens et statistiques en CSV |
| GET | /v1/public/qr/r/:slug | None | — | Public — redirige le lien court et enregistre le scan |
| GET | /v1/public/qr/:id.svg | None | — | Public — sert le code QR au format SVG |
Onboarding
Flux d'onboarding multi-étapes avec suivi de progression et webhooks de complétion.
| Méthode | Chemin | Auth | Scope | Description |
|---|---|---|---|---|
| GET | /v1/onboarding/flows | Bearer | onboarding:read | Liste tous les flux d'onboarding |
| POST | /v1/onboarding/flows | Bearer | onboarding:write | Crée un nouveau flux d'onboarding |
| GET | /v1/onboarding/sessions | Bearer | onboarding:read | Liste les sessions d'onboarding |
| GET | /v1/onboarding/export.csv | Bearer | onboarding:read | Exporte les sessions en CSV |
| POST | /v1/public/onboarding/sessions | None | — | Public — démarre une nouvelle session |
| PATCH | /v1/public/onboarding/sessions/:id | None | — | Public — fait avancer la session à l'étape suivante |
Factures
Factures et reçus numériques et imprimables avec livraison par email.
| Méthode | Chemin | Auth | Scope | Description |
|---|---|---|---|---|
| GET | /v1/invoice/invoices | Bearer | invoice:read | Liste toutes les factures |
| POST | /v1/invoice/invoices | Bearer | invoice:write | Crée une nouvelle facture |
| GET | /v1/invoice/invoices/:id/print | Bearer | invoice:read | Génère la facture en PDF imprimable |
| GET | /v1/invoice/export.csv | Bearer | invoice:read | Exporte les factures en CSV |
Besoin d'aide ?
Rejoignez notre communauté ou consultez la FAQ dans la barre latérale.