API KeyWe

Authentification

Chaque requête doit porter votre clé API dans l'en-têteAuthorization. Les clés commencent parkw_live_ et ne sont affichées qu'une seule fois : conservez-les comme un mot de passe.

À la création, vous choisissez les droits de la clé — Lecture (consulter vos trousseaux) et/ou Création de codes. Accordez le minimum nécessaire : une clé dépourvue du droit requis reçoit un 403. L'API est par ailleurs limitée à 120 requêtes par minute et par clé (réponse 429, en-tête Retry-After).

curl https://keywe.io/api/v1/cles \
  -H "Authorization: Bearer kw_live_your_key"

Points d'entrée

• GET/api/v1/clesListe vos trousseaux : statut, lieu, case, échéance de retour.
• POST/api/v1/codesCrée un code de retrait pour une clé et l'envoie au bénéficiaire par email.

Créer un code de retrait

L'appel type au moment d'une réservation : le voyageur reçoit son code par email, valable 7 jours.

curl -X POST https://keywe.io/api/v1/codes \
  -H "Authorization: Bearer kw_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "key_id": "b0000000-0000-4000-a000-000000000001",
    "beneficiaire_nom": "Léa Martin",
    "beneficiaire_email": "lea@exemple.fr",
    "validite_jours": 7
  }'

Réponse

{
  "id": "c0000000-0000-4000-a000-000000000009",
  "code": "H7KM2P",
  "qr_payload": "KEYWE:H7KM2P",
  "expire_le": "2026-07-30T10:00:00.000Z",
  "cle_en_depot": true
}

Codes de réponse