Vérification de la Disponibilité via l'API Yoplanning

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

Cette méthode de l'API permet de vérifier si le contenu du panier est toujours disponible avant la finalisation de la commande. Elle est particulièrement utile pour éviter les situations de sur-réservation dans le cas où de nombreux clients effectuent des réservations simultanément.


Exemple d'utilisation avec CURL

Endpoint :

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

Description :

Vous devez envoyer le même JSON que celui utilisé pour passer une commande, la seule différence étant l'URL.

Exemple :

curl -H "Content-Type: application/json" -X POST -d '{
    "external_reference" : "956",
    "items" : [{
        "session_group" : "53071a97-0c2d-4973-89f5-cafd10665b3b",
        "price" : {"amount" : 51.25},
        "client" : {
            "id" : "71ea849f-226c-4302-a433-528179634aa7",
            "first_name" : "John",
            "last_name" : "Doe",
            "email" : "john.doe@gmail.com"
        }
    }],
    "payments" : [{
        "amount" : 51.25,
        "client" : {
            "first_name" : "Framold",
            "last_name" : "Doe",
            "email" : "john.doe@gmail.com"
        }
    }]
}' https://yoplanning.pro/api/v3.1/teams/5a90332e-568f-4980-9859-88a984844a4d/order-validation -H 'Authorization: Token 4504c2cb0d87a93106d4de029f407c86149f2ada'

Réponse en cas de disponibilité :

{
    "success": true
}

Réponse en cas d'indisponibilité :

{
    "success": false, 
    "unavailable_items": {
        "group_ids": ["2265cac0-cba5-46eb-8095-b89f93e7473f"], 
        "dry_resource_ids": [], 
        "voucher_ids": [], 
        "resources": []
    }
}

Conseils d'utilisation et bonnes pratiques

  1. Vérifier avant chaque finalisation de commande : Utiliser cette méthode avant de finaliser une commande pour s'assurer que toutes les ressources nécessaires sont toujours disponibles.

  2. Gestion des erreurs : En cas de non-disponibilité, prévoir une gestion des erreurs appropriée pour informer le client et lui proposer des alternatives.

  3. Automatisation : Intégrer cette vérification dans un processus automatisé pour des transactions en temps réel, surtout en période de forte activité.


Erreurs courantes et solutions

  1. Erreur 404 (Not Found) :

    • Cause : Mauvais endpoint ou teamId incorrect.

    • Solution : Vérifier l’URL et le teamId utilisé.

  2. Erreur 401 (Unauthorized) :

    • Cause : Problème d'authentification.

    • Solution : Vérifier le token d'authentification et s'assurer qu'il est valide et actif.

  3. Erreur 400 (Bad Request) :

    • Cause : Format JSON incorrect ou données manquantes.

    • Solution : Vérifier que le JSON envoyé est correctement formaté et que toutes les informations nécessaires sont incluses.

Dernière mise à jour

Logo

Site commercial :

Yoplanning

Copyright Vakario 2023