NjanggoNjanggoDocumentation API
Pro

Check-in

Scanner QR, borne kiosque et écran d'accueil temps réel.

POST/v1/events/:eventId/checkins
LivecreateCheckin

Chemin actuel : /api/v1/events/:eventId/checkins

Scopes : checkins:write

Paramètres

Modifiez les valeurs puis cliquez Try It! à droite.

eventIdpathrequis

Segment d'URL :eventId

x-njanggo-api-keyheaderrequis

Clé API (Try It!)

Corps (JSON)

Flux kiosque recommandé

  1. 1

    Scan

    Appareil lit le QR code du billet (ou saisie manuelle).

  2. 2

    Lookup

    GET .../checkins/lookup?qrCode= — afficher nom, billet, déjà check-in ?

  3. 3

    Confirmer

    Staff appuie OK → POST .../checkins avec le qrCode.

  4. 4

    Live

    Webhook checkin.created → WebSocket / écran géant / compteur Slack.

Lookup QR

GET lookup — 200

200
application/json
{
  "data": {
    "guestId": "gst_xyz789",
    "name": "Alice Martin",
    "email": "alice@example.com",
    "status": "CONFIRMED",
    "ticketName": "Entrée standard",
    "alreadyCheckedIn": false
  }
}
ErreurCodeCause
QR inconnu404Billet invalide ou autre event
Déjà check-in409alreadyCheckedIn: true dans lookup
Event pas encore ouvert403Hors fenêtre check-in

Endpoints

GET
/v1/events/:id/checkins

Liste complète + horodatage

GET
/v1/events/:id/checkins/lookup?qrCode=

Pré-validation

POST
/v1/events/:id/checkins

{ qrCode } ou { guestId }

GET
/public/qr/:qrCode

PNG QR (emails, affichage)

Temps réel

checkin.created

200
application/json
{
  "type": "checkin.created",
  "data": { "guestName": "Alice Martin", "checkedInAt": "..." }
}