Récupérer le schéma d'une locale

  • Countries
  • Services
  • 2 routes
Comment récupérer le schéma de validation d'une ressource pour une locale ou un pays donné ?

Ce scénario explique comment récupérer le schéma de validation associé à une ressource Club Med API pour une locale ou un pays donné. Il permet d'identifier les locales disponibles, puis de récupérer le JSON Schema utilisé pour valider une ressource comme profile ou billing.

Vue d'ensemble

Utilisez ce scénario lorsqu'une application doit valider ses payloads avec le schéma attendu par une ressource Club Med API. Le parcours commence par la liste des locales disponibles pour la clé API courante, puis récupère le schéma de la ressource cible pour la locale choisie.

Prérequis

  • Une clé x-api-key valide.
  • La valeur de resource à cibler. Avec les sources disponibles pour ce scénario, les valeurs vérifiées sont profile et billing.
  • Une valeur localeOrCountry compatible avec la route, par exemple un code pays ou une locale retournée par GET/v0/locales.
  • Si votre intégration dépend d'un contexte de proposition, proposal_id peut être transmis lorsque c'est pertinent.

NOTE

La réponse suit un format JSON Schema et peut être utilisée pour valider un payload côté client ou côté serveur avant d'appeler une autre route.

Process workflow

Legend:
Obligatoire
Optionnel
1

Lister les locales disponibles

Obligatoire

Utilisez GET/v0/locales pour lister les locales disponibles avec la clé API courante avant d'appeler une route qui dépend d'une locale ou d'un pays.

Prérequis

  • Une clé x-api-key valide.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v0/locales' \
  -H 'accept: application/json' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

[
  "fr-FR",
  "fr-BE",
  "nl-BE",
  "de-CH",
  "fr-CH",
  ...
]

Info: réutilisez l'une des valeurs de locale retournées pour construire la requête suivante vers GET/v3/schemas/{resource}/{localeOrCountry} lorsque votre intégration dépend d'une validation contextualisée par locale.

Codes de réponse

  • OK Response (200): retourne la liste des locales prises en charge pour la clé API courante.
  • Error (400): bad_request ou validation_error.
  • Error (401): non documenté dans le Swagger.
  • Error (403): forbidden lorsque la clé API n'est pas autorisée à accéder à la route.
  • Error (404): non documenté dans le Swagger.
GET/v0/locales
Voir plus
2

Récupérer le schéma de la ressource

Obligatoire

Utilisez GET/v3/schemas/{resource}/{localeOrCountry} pour récupérer le JSON Schema associé à une ressource et à une locale ou un pays cible.

Prérequis

  • Une clé x-api-key valide.
  • Une valeur resource prise en charge. Avec les sources disponibles, les valeurs documentées sont profile et billing.
  • Une valeur localeOrCountry compatible avec la route, par exemple fr-FR ou FR.
  • Si la requête dépend d'un contexte de proposition, un proposal_id optionnel.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v3/schemas/profile/fr-FR?proposal_id=123456' \
  -H 'accept: application/json' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

{
  "title": "ProfileSchema_fr-FR",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-test/v1/schemas/resource/fr-FR",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "string"
  ],
  "definitions": "string",
  "properties": "string"
}

Info: réutilisez les clés required et properties retournées pour piloter la validation côté client ou côté serveur avant d'envoyer un payload vers une autre route.

Codes de réponse

  • OK Response (200): retourne le JSON Schema correspondant à la ressource et à la locale ou au pays demandés.
  • Error (400): entrée invalide ou manquante, y compris bad_request ou validation_error.
  • Error (401): non documenté dans le Swagger.
  • Error (404): not_found lorsqu'aucun schéma ne correspond à la combinaison demandée.
GET/v3/schemas/{resource}/{localeOrCountry}
Voir plus