Tutoriel d'accès au catalogue

Introducción

Esta documentación tiene como objetivo guiar a los desarrolladores en la integración del catálogo de ventas y la gestión de pedidos, con o sin pago, mediante la API de Yoplanning.pro. El objetivo es habilitar la venta de actividades de Yoplanning dentro de su sistema. Partimos de la base de que ya ha revisado la documentación de la API y dispone de su token de API.

Pasos del flujo de trabajo de integración

1. Recuperación de los datos de su equipo

• Punto final: /api/v3.1/teams/

• Información esencial: team_id y vendor_id

• Uso: El team_id es necesario para casi todas las solicitudes de API. El vendor_id es necesario si desea utilizar el Administrador de pagos.

2. Obtención de la lista de productos

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

• Función: Recupera la lista de productos que se pueden vender en línea.

• Parámetros adicionales:

  • lang: (cadena) Indica el idioma de los campos traducibles (como título, descripción, etc.). Utilice un código ISO2. Valor predeterminado: en (inglés). Opciones posibles: fr (francés), de (alemán).

  • start_date: (fecha) Filtra los resultados para mostrar solo aquellos con disponibilidad posterior a esta fecha. Formato de fecha: AAAA-MM-DD.

  • end_date: (fecha) Filtra los resultados para mostrar solo aquellos con disponibilidad anterior a esta fecha. Formato de fecha: AAAA-MM-DD.

  • categoría: (cadena) Filtra los productos por categoría específica.

3. Recuperación de la disponibilidad del producto

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

• Función: Muestra las sesiones disponibles para un producto específico.

• Filtrado: Fecha, precio, número de entradas, personal (instructor), etc.

4. (Opcional) Recuperación de las opciones disponibles (equipos)

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

• Función: Recupera los detalles de las opciones disponibles para una sesión específica.

5. (Opcional) Verificación de disponibilidad

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

• Función: Permite comprobar si los artículos del carrito siguen disponibles antes de finalizar el pedido.

• Para obtener más detalles, haga clic aquí

6. (Opcional) Crear un pago a través del Gestor de pagos

• Punto final: https://payment.yoplanning.pro/api/create-payment

• Función: Crea un pago y recupera el enlace de pago.

• Gestión de IPN: Gestión de notificaciones de pago instantáneas en la URL de devolución de llamada proporcionada.

YoPlanning Payment Manager — API Documentation

7. Realizar el pedido

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

• Función: Registra el pedido en Yoplanning, actualiza el horario, muestra el pedido y los participantes en Yoplanning, notifica al personal y actualiza la disponibilidad.

• Opción: Si prefiere gestionarlo usted mismo, puede solicitar al sistema YoPlanning que no envíe la confirmación por correo electrónico.

  /api/v3.1/teams/{teamId}/orders/?send_email=0

Ejemplo de uso con cURL

• Recuperación de producto:

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

\* **Recuperando la disponibilidad del producto**: ```bash 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' ``` * **Realice su pedido**: ```bash 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" : "[email protected]"}}], "payments" : [{"amount" : 51.25, "client" : {"first_name" : "Framold", "last_name" : "Doe", "email" : "[email protected]"}}]}' https://yoplanning.pro/api/v3.1/teams/5a90332e-568f-4980-9859-88a984844a4d/orders -H 'Authorization: Token 4504c2cb0d87a93106d4de029f407c86149f2ada' ```

Asegúrate de reemplazar los ID y tokens con los de tu equipo para todas las solicitudes.

---

Nota: Esta documentación es un ejemplo básico de integración. Para obtener información más específica y casos de uso avanzados, consulte la documentación oficial de la API de Yoplanning.pro.