Tutorial zum Katalogzugriff
Einführung
Ziel dieser Dokumentation ist es, Entwickler bei der Integration des Verkaufskatalogs und der Bestellung mit oder ohne Bezahlung über die Yoplanning.pro-API anzuleiten. Ziel ist es, den Verkauf von Yoplanning-Aktivitäten innerhalb Ihres Systems zu ermöglichen. Wir gehen davon aus, dass Sie die API-Dokumentation bereits gelesen haben und Ihr API-Token besitzen.
Schritte des Integrationsworkflows
1. Wiederherstellung der Daten Ihres Teams
Endpunkt:
/api/v3.1/teams/Wichtige Informationen: „team_id“ und „vendor_id“.
Verwendung: Die „team_id“ ist für fast alle API-Anfragen erforderlich. Die „vendor_id“ ist notwendig, wenn Sie den Payment Manager nutzen möchten.
2. Erhalten der Produktliste
Endpunkt:
/api/v3.1/teams/[teamId]/online-products/Funktion: Ruft die Liste der Produkte ab, die online verkauft werden können.
Zusätzliche Parameter:
lang: (string) Gibt die Sprache übersetzbarer Felder an (wie Titel, Beschreibung usw.). Verwenden Sie einen ISO2-Code. Standard:
en(Englisch). Mögliche Optionen: „fr“ (Französisch), „de“ (Deutsch).Startdatum: (Datum) Filtert Ergebnisse, um nur diejenigen zurückzugeben, die nach diesem Datum verfügbar sind. Datumsformat: „JJJJ-MM-TT“.
end_date: (Datum) Filtert Ergebnisse, um nur diejenigen zurückzugeben, deren Verfügbarkeit vor diesem Datum liegt. Datumsformat: „JJJJ-MM-TT“.
Kategorie: (Zeichenfolge) Filtert Produkte nach einer bestimmten Kategorie.
3. Wiederherstellung der Produktverfügbarkeit
Endpunkt:
/api/v3.1/teams/[teamId]/online-products/[productId]/availabilities/Funktion: Zeigt verfügbare Sitzungen für ein bestimmtes Produkt an.
Filterung: Datum, Preis, Anzahl der Tickets, Personal (Lehrer) usw.
4. (Optional) Wiederherstellung verfügbarer Optionen (Ausrüstung)
Endpunkt:
/api/v3.1/teams/[teamId]/availability-details/[pk]/Funktion: Ruft Details zu den Optionen ab, die für eine bestimmte Sitzung verfügbar sind.
5. (Optional) Verfügbarkeit prüfen
Endpunkt:
/api/v3.1/teams/[teamId]/order-validationFunktion: Ermöglicht Ihnen, vor Abschluss der Bestellung zu prüfen, ob der Inhalt des Warenkorbs noch verfügbar ist.
6. (Optional) Erstellen einer Zahlung über den Zahlungsmanager
Endpunkt: „https://zahlung.yoplanning.pro/api/create-zahlung“.
Funktion: Erstellt eine Zahlung und ruft den Zahlungslink ab.
IPN-Verwaltung: Verwaltung der Sofortzahlungsbenachrichtigung über die angegebene Rückruf-URL.
7. Bestellung aufgeben
Endpunkt:
/api/v3.1/teams/[teamId]/orders/Funktion: Registriert die Bestellung in Yoplanning, aktualisiert den Zeitplan, zeigt die Bestellung und Teilnehmer in Yoplanning an, benachrichtigt das Personal und aktualisiert die Verfügbarkeit.
Beispiel für die Verwendung mit cURL
Rückgewinnung von Produkten:
* **Abfrage der Produktverfügbarkeit**: ```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' ``` * **Die Bestellung aufgeben**: ```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" : "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/orders -H 'Authorization: Token 4504c2cb0d87a93106d4de029f407c86149f2ada' ```
Stellen Sie sicher, dass Sie bei allen Anfragen die IDs und Token durch die Ihres Teams ersetzen.
Hinweis: Diese Dokumentation ist ein einfaches Integrationsbeispiel. Weitere spezifische Details und erweiterte Anwendungsfälle finden Sie in der offiziellen Yoplanning.pro-API-Dokumentation.
Last updated