Questions fréquentes

Composantes d'une requête

Une requête lambda envoyée à notre API ressemblera à ceci :

curl --location --globoff 'https://gateway.prod.gravitee.stadline.tech/resa2-staging/${clientToken}/class_events' \
--header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...' \
--header 'x-user-club-id: /demoapi/clubs/1210' \
--header 'x-user-network-node-id: /demoapi/network_nodes/1053' \
--header 'x-gravitee-api-key: xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx'

On y retrouve :

Composante	Description
https://gateway.prod.gravitee.stadline.tech/	obligatoire L'URL de base de notre API Gateway
demoapi	obligatoire Ce que l'on appel clientToken : C'est l'identifiant unique d'un client resamania
x-user-club-id	obligatoire Le header contenant l'IRI du club pour lequel vous souhaitez récupérer/enregistrer les informations
x-user-network-node-id	Le header contenant l'IRI du noeud réseau pour lequel vous souhaitez récupérer/enregistrer les informations. facultatif Facultatif si votre client n'a qu'un seul club obligatoire Il est obligatoire si vous travaillez avec des chaînes de club
x-gravitee-api-key	obligatoire Votre clé d'itentification sur l'API Gateway
Bearer ...	obligatoire Est le token généré via un endpoint d'authentification

J'ai une erreur 401 Unauthorized

Cette erreur est très généralement renvoyée par notre API Gateway et est significatif d'un oubli du header x-gravitee-api-key.

curl --location 'https://gateway.prod.gravitee.stadline.tech/resa2-staging/oauth/v2/token' \
--header 'x-gravitee-api-key: c803xxx-yyyy-zzz-xxxx-f635b354435a' \
--form 'grant_type="client_credentials"' \
--form 'client_id="123_xxxxxxxxxxxxxxxxx"' \
--form 'client_secret="******************'\''"'

J'ai une erreur 404 Item not found

Dans la très grande majorité des cas l'erreur va provenir de l'une des composante de votre requête :

• Avez-vous bien fournit le clientToken dans l'URL ?
• Les headers de réseau sont-ils bien renseignés ?
• N'oubliez pas que vous devez fournir des IRI et non des ids (/demoapi/clubs/123 et non juste 123)

J'ai une erreur 403 api.error.scope.unauthorized-endpoint

Si vous êtes en sandbox: Tous les endpoints vous sont ouverts sans restriction, le problème vient donc très probablement de l'une des compostante de votre URL, et très certainement d'un oubli du clientToken.

Si vous êtes en production c'est que cet endpoint ne vous est effectivement pas autorisé : Contactez notre service API.

Le retour API ne contient pas l'élément que je recherche, que je m'attends à recevoir

Que ce soit des produits, des offres, des contacts, etc. :

• Vérifiez les headers de votre requête, surtout si le client est configuré en réseau, cf. le fonctionnement des chaînes
• Récupérez vous suffisament d'éléments ? Nos pages sont limitées par défaut à 30 éléments, vous pouvez soit paginer (?page=2) soit augmenter le nombre d'éléments par page (?itemsPerPage=30, dans la limite du raisonnable)