Gérer les voyageurs et documents de voyage d'un client

Réservation
Compte client
5 routes

Comment gérer les voyageurs et leurs documents de voyage pour un compte client ?

Ce scénario documente comment lister les voyageurs rattachés à un compte client, créer de nouveaux voyageurs, récupérer les documents de voyage, les mettre à jour et résoudre le bon client si nécessaire.

Vue d'ensemble

Utilisez ce scénario pour gérer les voyageurs rattachés à un compte client et maintenir leurs documents de voyage à jour. Le parcours combine la lecture et la création de travelers, la relecture des documents de voyage, leur mise à jour et, si besoin, la recherche du bon compte client avant modification.

Prérequis

Un customer_id valide est requis sur les routes de travelers et de travel documents.
Les routes en scope client nécessitent authorization, et tous les appels documentés demandent accept-language et x-api-key.
Une recherche client peut être nécessaire pour retrouver le bon compte avant la mise à jour documentaire.

Process workflow

Legend:

Obligatoire

Optionnel

Lister les voyageurs rattachés au client

Obligatoire

Utilisez GET/v1/customers/{customer_id}/travelers pour lister les voyageurs rattachés au client.

Prérequis

Préparez customer_id. Conservez x-api-key et, si la route est customer-scoped, un bearer token valide.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: fr-FR" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  "https://api.clubmed.com/v1/customers/{customer_id}/travelers"

Example answer

[
  {
    "id": "traveler-1",
    "first_name": "Jane",
    "last_name": "Doe"
  }
]

info: Exploitez cette liste pour vérifier quels voyageurs sont déjà rattachés au client avant d'en créer un nouveau ou de mettre à jour des documents.

Codes de réponse

200 OK : les données attendues sont renvoyées.
400 Bad Request : la requête est invalide ou incomplète.
401 Unauthorized : le token est manquant ou invalide.
403 Forbidden : l'accès est refusé dans ce contexte.
404 Not Found : la ressource demandée est introuvable.

GET/v1/customers/{customer_id}/travelers

Créer un voyageur

Obligatoire

Utilisez POST/v1/customers/{customer_id}/travelers pour créer un voyageur supplémentaire sur le compte client avant de travailler sur ses documents de voyage.

Prérequis

Préparez customer_id. Conservez x-api-key et, si la route est customer-scoped, un bearer token valide. Vérifiez le body avant appel pour éviter une erreur de validation.

Calling CURL

curl -X POST \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: fr-FR" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"first_name": "Jane", "last_name": "Doe", "birthdate": "1990-03-12"}' \
  "https://api.clubmed.com/v1/customers/{customer_id}/travelers"

Example answer

{
  "id": "traveler-1",
  "first_name": "Jane",
  "last_name": "Doe"
}

info: Conservez l'id du voyageur retourné si ce même profil doit être réutilisé ou rapproché dans des opérations client ultérieures.

Codes de réponse

200 OK : l'opération est prise en compte et la ressource est renvoyée.
400 Bad Request : le body ou les paramètres sont invalides.
401 Unauthorized : le token est manquant ou invalide.
403 Forbidden : l'accès est refusé dans ce contexte.
404 Not Found : la ressource ciblée est introuvable.

POST/v1/customers/{customer_id}/travelers

Récupérer les documents de voyage

Obligatoire

Utilisez GET/v1/customers/{customer_id}/travel_documents pour relire les documents de voyage déjà connus du client avant de décider si l'un d'eux doit être mis à jour.

Prérequis

Préparez customer_id. Conservez x-api-key et, si la route est customer-scoped, un bearer token valide.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: fr-FR" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  "https://api.clubmed.com/v1/customers/{customer_id}/travel_documents"

Example answer

[
  {
    "id": "doc-1",
    "type": "PASSPORT",
    "number": "XX123456",
    "expiration_date": "2030-07-01"
  }
]

info: Réutilisez l'id, le type et la date d'expiration pour identifier le document qui doit être modifié.

Codes de réponse

200 OK : les données attendues sont renvoyées.
400 Bad Request : la requête est invalide ou incomplète.
401 Unauthorized : le token est manquant ou invalide.
403 Forbidden : l'accès est refusé dans ce contexte.
404 Not Found : la ressource demandée est introuvable.

GET/v1/customers/{customer_id}/travel_documents

Mettre à jour les documents de voyage

Obligatoire

Utilisez PATCH/v1/customers/{customer_id}/travel_documents pour mettre à jour les documents de voyage.

Prérequis

Préparez customer_id. Conservez x-api-key et, si la route est customer-scoped, un bearer token valide. Vérifiez le body avant appel pour éviter une erreur de validation.

Calling CURL

curl -X PATCH \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: fr-FR" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"documents": [{"id": "doc-1", "number": "XX123456", "expiration_date": "2030-07-01"}]}' \
  "https://api.clubmed.com/v1/customers/{customer_id}/travel_documents"

Example answer

HTTP/1.1 204 No Content

info: Le succès peut être renvoyé sans body. Relisez la ressource ensuite si vous devez afficher l'état final.

Codes de réponse

204 No Content : l'opération est appliquée avec succès.
400 Bad Request : le body ou les paramètres sont invalides.
401 Unauthorized : le token est manquant ou invalide.
403 Forbidden : l'accès est refusé dans ce contexte.
404 Not Found : la ressource ciblée est introuvable.

PATCH/v1/customers/{customer_id}/travel_documents

Rechercher le bon compte client

Optionnel

Utilisez GET/v1/customers pour rechercher le bon compte client.

Prérequis

Préparez les paramètres utiles à l'appel. Conservez x-api-key et, si la route est customer-scoped, un bearer token valide.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: fr-FR" \
  "https://api.clubmed.com/v1/customers"

Example answer

[
  {
    "id": "customer-1",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@example.com"
  }
]

info: Réutilisez les identifiants clients renvoyés pour poursuivre les opérations sur les voyageurs et les documents de voyage du bon compte.

Codes de réponse

200 OK : les données attendues sont renvoyées.
400 Bad Request : la requête est invalide ou incomplète.
404 Not Found : la ressource demandée est introuvable.

GET/v1/customers