Tutoriel d'accès au catalogue

Workflow d'accès aux données et passage des commandes avec ou sans appel du système de paiement. Document Payraud, introduction

Introduction

Cette documentation vise à guider les développeurs dans l'intégration du catalogue de vente et du passage de commande, avec ou sans paiement, en utilisant l'API de Yoplanning.pro. L'objectif est de permettre la vente des activités Yoplanning au sein de votre système. Nous supposons que vous avez déjà pris connaissance de la documentation de l'API et que vous possédez votre token API.

Étapes du Workflow d'Intégration

1. Récupération des Données de votre Team

• Endpoint : /api/v3.1/teams/

• Informations Essentielles : team_id et vendor_id

• Utilisation : Le team_id est requis pour presque toutes les requêtes sur l'API. Le vendor_id est nécessaire si vous souhaitez utiliser le gestionnaire de paiement (Payment Manager).

2. Obtention de la Liste des Produits

• Endpoint : /api/v3.1/teams/[teamId]/online-products/

• Fonction : Récupère la liste des produits pouvant être vendus en ligne.

• Paramètres supplémentaires :

  • lang : (string) Indique la langue des champs translatables (comme le titre, la description, etc.). Utilisez un code ISO2. Par défaut : en (anglais). Options possibles : fr (français), de (allemand).

  • start_date : (date) Filtre les résultats pour ne retourner que ceux avec des disponibilités après cette date. Format de date : AAAA-MM-JJ.

  • end_date : (date) Filtre les résultats pour ne retourner que ceux avec des disponibilités avant cette date. Format de date : AAAA-MM-JJ.

  • category : (string) Filtre les produits par catégorie spécifique.

3. Récupération des Disponibilités d'un Produit

• Endpoint : /api/v3.1/teams/[teamId]/online-products/[productId]/availabilities/

• Fonction : Affiche les sessions disponibles pour un produit spécifique.

• Filtrage : Date, prix, nombre de billets, personnel (instructeur), etc.

4. (Optionnel) Récupération des Options Disponibles (Équipements)

• Endpoint : /api/v3.1/teams/[teamId]/availability-details/[pk]/

• Fonction : Récupère les détails des options disponibles pour une session spécifique.

5. (Optionnel) Vérification de la Disponibilité

• Endpoint : /api/v3.1/teams/[teamId]/order-validation

• Fonction : Permet de vérifier si le contenu du panier est toujours disponible avant la finalisation de la commande.

• Voir plus de détails, cliquez ici

6. (Optionnel) Création d'un Paiement via le Gestionnaire de Paiement

• Endpoint : https://payment.yoplanning.pro/api/create-payment

• Fonction : Crée un paiement et récupère le lien de paiement.

• Gestion IPN : Gestion de la Notification de Paiement Instantané sur l'URL de callback fournie.

7. Passation de la Commande

• Endpoint : /api/v3.1/teams/[teamId]/orders/

• Fonction : Enregistre la commande dans Yoplanning, met à jour le planning, affiche la commande et les participants dans Yoplanning, notifie le personnel et met à jour les disponibilités.

Exemple d'Utilisation avec cURL

• Récupération des Produits :

  curl https://yoplanning.pro/api/v3.1/teams/5a90332e-568f-4980-9859-88a984844a4d/online-products -H 'Authorization: Token 4504c2cb0d87a93106d4de029f407c86149f2ada'

• Récupération des Disponibilités d'un Produit :

  curl https://yoplanning.pro/api/v3.1/teams/5a90332e-568f-4980-9859-88a984844a4d/online-products/f16ed6c6-e972-4232-b452-ecd393e61642/availabilities -H 'Authorization: Token 4504c2cb0d87a93106d4de029f407c86149f2ada'

• Passation de la Commande :

  curl -H "Content-Type: application/json" -X POST -d '{"external_reference" : "956", "items" : [{"session_group" : "4f655815-58d9-4c7c-b1c9-2ea152073371", "price" : {"amount" : 51.25}, "client" : {"id" : "71ea849f-226c-4302-a433-528179634aa7", "first_name" : "John", "last_name" : "Doe", "email" : "[e-mail]"}}], "payments" : [{"amount" : 51.25, "client" : {"first_name" : "Framold", "last_name" : "Doe", "email" : "[e-mail]"}}]}' https://yoplanning.pro/api/v3.1/teams/5a90332e-568f-4980-9859-88a984844a4d/orders -H 'Authorization: Token 4504c2cb0d87a93106d4de029f407c86149f2ada'

Assurez-vous de remplacer les identifiants et tokens par ceux de votre Team pour toutes les requêtes.

---

Note : Cette documentation est un exemple basique d'intégration. Pour des détails plus spécifiques et des cas d'utilisation avancés, veuillez consulter la documentation officielle de l'API Yoplanning.pro.