Pro

Clés API

Créez, scopez et révoquez les clés d'accès REST Pro.

Dans cet article

Créer une clé
Scopes
Rate limits
Gestion
Endpoints /v1 live
Tester

GET/v1/calendars/mon-calendrier

Preview

Try It! → /api/calendars/mon-calendrier

OpenAPI Télécharger Postman /api → /v1

Paramètres

Modifiez les valeurs puis cliquez Try It! à droite.

Authorizationheaderrequis

Token Bearer Clerk (session dashboard)

Créer une clé

1
Accéder au panneau
Calendrier Pro → Développeur → Clés API.
2
Nommer
Ex. « Production CRM », « Staging kiosque ».
3
Scopes
Cochez le minimum — ex. guests:read seul pour un export automatique.
4
Copier nj_live_…
Affichée une seule fois. Stockez dans vos secrets serveur.

Scopes

Scope	Permissions
events:read	GET calendrier, events, billets, stats
events:write	POST/PATCH/DELETE events, billets, cancel, duplicate
guests:read	GET guests, rsvps, export CSV/JSON
guests:write	Invite, approve, reject, status, transfer
checkins:read	GET checkins list
checkins:write	lookup QR + POST checkin
communications:write	Annonces et rappels e-mail
webhooks:read	GET webhook-deliveries, logs
webhooks:write	POST retry livraison
billing:read	GET orders, sales-report
billing:write	POST refund — irréversible
analytics:read	Stats agrégées calendrier

Matrice endpoint × scope (extrait)

Endpoint	Scopes requis
GET /api/v1/calendars/:slug	events:read
POST /api/v1/events	events:write
GET /api/v1/calendars/:slug/events	events:read
GET /api/v1/events/:slug	events:read
GET /api/v1/events/:eventId/guests	guests:read
POST /api/v1/events/:eventId/guests	guests:write
GET /api/v1/events/:eventId/export	guests:read
POST /api/v1/events/:eventId/checkins	checkins:write
GET /api/v1/events/:eventId/checkins/lookup	checkins:read
GET /api/v1/events/:eventId/checkins	checkins:read
GET /api/v1/webhook-deliveries	webhooks:read
POST /api/v1/webhook-deliveries/:id/retry	webhooks:write

Rate limits & gouvernance

Plan	Quota journalier	Burst	Note
Plus	—	—	Pas d’API REST — webhooks & intégrations no-code
Pro	10 000 req/j	60 req/min	Headers X-RateLimit-*
Enterprise	Contractuel	Contractuel	SLA 99,9 %

Bonnes pratiques

Idempotency-Keyheaderoptionnel

UUID sur POST check-in, invite batch, refund — évite les doublons

nj_live_ / nj_test_prefixoptionnel

Production vs sandbox Enterprise

Rotationprocessoptionnel

Créer nouvelle clé → migrer → révoquer l’ancienne

X-RateLimit-*headers réponseoptionnel

Limit, Remaining, Reset — 429 si dépassé

Gestion (live)

Les clés se gèrent sous /api/calendars/:slug/api-keys (Bearer owner/admin). L'alias cible /api/v1/api-keys n'est pas encore exposé.

GET

/calendars/:slug/api-keys/scopes

Catalogue des scopes disponibles

GET

/calendars/:slug/api-keys

Lister (id, name, prefix, scopes, lastUsedAt)

POST

/calendars/:slug/api-keys

Créer { name, scopes[] } → plainKey une fois

PATCH

/calendars/:slug/api-keys/:id

Renommer, désactiver (isActive: false)

DELETE

/calendars/:slug/api-keys/:id

Révoquer définitivement

Endpoints /v1 disponibles

Juillet 2026

GET  /api/v1/calendars/:slug              events:read
GET  /api/v1/events/:eventId/guests       guests:read
GET  /api/v1/events/:eventId/export       guests:read
GET  /api/v1/events/:eventId/checkins     checkins:read
GET  /api/v1/events/:eventId/checkins/lookup  checkins:read
POST /api/v1/events/:eventId/checkins     checkins:write

CRUD events, billing API, logs webhooks : voir Roadmap.

Tester l'authentification

curl -X GET "https://api.njanggo.com/api/v1/calendars/mon-collectif" \
  -H "x-njanggo-api-key: $NJANGGO_API_KEY"

401 = clé invalide ou calendrier non Pro. 403 = scope insuffisant.