Ressources à disposition des dévelopeurs
L'API Gateway
L'API Gateway et son developer portal est votre companion pour une intégration facilitée, découvrez comment l'utiliser dans l'article qui lui est dédié ici.
Pour vous aider dans vos développements, profiter notamment des logs détaillés en sandbox : Vous n'avez pas à loguer vos requêtes/réponses lors de vos développements, vous pouvez simplement consulter les logs depuis le developer portal.
NOTE
Les logs détaillés ne sont pas ouvert en production, ils ne le sont qu'en sandbox Nous vous conseillions donc de garder un système de log de votre côté, à minima pour les erreurs.
Créez des alertes pour être alerté en cas d'erreur, vous pouvez être alertés sur différents canaux (notamment slack) dès lors que votre application dépasse un certain taux d'erreur (entre autres) : Utile pour être prévenu des problèmes survenant en production.
Collection Bruno
Notre collection Bruno est disponible ici.
Elle contient toute notre API référence et est configurée de sorte à ce que vous n'ayez qu'à renseigner les variables d'environnement pour être prêts à utiliser nos APIs.
Elle s'accompagne de scénarios représentants les cas pratiques les plus courants (inscription, vente en ligne, ...).
Notre page de statut
Chaque environnement a une page de statut dédié vous permettant
- De vérifier le statut et la disponibilité de nos APIs
- De vous inscrire pour être alerté en cas de maintenance à venir / en cours
Pour l'environnement FR/ES, la page de statut est https://resamania.statuspage.io/
Codes source d'exemple
Quelques exemples d'intégration peuvent être retrouvés dans le repository github dédié.
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 |