Vorbereitung
API Key erstellen
Öffne im Dashboard das Entwickler-Menü und navigiere zum Punkt API Keys. Klicke nun auf Neue API Keys hinzufügen.
Wichtig: Speichere dir den Secret Key gut ab und gebe ihn niemals an dritte weiter!
API anfragen
Nutze nun den Endpunkt /orders/link/carbon, um mit einer fixen Summe CO2 Emissionen einen Checkout Link zu erstellen oder nutze den Endpunkt /orders/link/price, um mit einem fixen Betrag in der gewünschten Währung einen Checkout Link zu erstellen.
Gut zu wissen: Du kannst auch unsere PHP Library oder unsere Node.js Library nutzen, um mit der API zu interagieren.
Optionen
Währung
Wähle mit Hilfe des Header-Parameters X-CURRENCY, in welcher Währung das Ergebnis der API und der Checkout Link zurückgegeben werden sollen. Es stehen über 100 Währungen zur Auswahl.
Sprache
Wähle mit Hilfe des Header-Parameters X-LOCALE, in welcher Sprache das Ergebnis der API und der Checkout Link zurückgegeben werden sollen.
Success & Cancel URLs
Wähle mit den Parametern success_url & cancel_url, wohin der Nutzer des Checkout Links jeweils nach erfolgreicher und abgebrochener Zahlung weitergeleitet werden soll.
Order Count
Passe den Parameter order_count an, um bis zu 3 Checkout Links mit einem API call zu erhalten.
Beispiel
In diesem Beispiel berechnen wir die Emissionen einer Fahrt von Berlin nach München und erstellen mit dem Ergebnis einen Checkout Link.
Checkout Link mit 500kg CO2e
POST/v2/orders/link/carbon
1 2 3 4 5{ "kgCO2e": 500, "success_url": "https://your-business.com/success", "cancel_url": "https://your-business.com/cancel" }
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31{ "payment_link": "https://klimapi.com/checkout/1c137daf-d3d7-42ad-8d7c-6429e8840957", "payment_link_id": "00000000-0000-0000-0000-000000000000", "certificate_url": null, "certificate_pdf": null, "order_id": "CA-0000-00000000", "price": 11.3, "currency": "EUR", "kgCO2e": 500, "payment_received": false, "project": { "id": "00000000-0000-0000-0000-000000000000", "title": "Example Project", "summary": "Example Summary", "status": "Active", "category_id": 3, "certification_authority_id": 2, "country": "Example Country", "description": null, "goals": null, "images": [ "https://cdn.klimapi.com/projects/00000000-0000-0000-0000-000000000000_1.jpeg", "https://cdn.klimapi.com/projects/00000000-0000-0000-0000-000000000000_2.jpeg" ], "benefits": [ 7, 8, 13 ] } }
Checkout Link für 10 Euro
POST/v2/orders/link/price
1 2 3 4 5 6{ "price_amount": 10, "change_allowed": true, "success_url": "https://your-business.com/success", "cancel_url": "https://your-business.com/cancel" }
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31{ "payment_link": "https://klimapi.com/checkout/1c137daf-d3d7-42ad-8d7c-6429e8840957", "payment_link_id": "00000000-0000-0000-0000-000000000000", "certificate_url": null, "certificate_pdf": null, "order_id": "CA-0000-00000000", "price": 10, "currency": "EUR", "kgCO2e": 448, "payment_received": false, "project": { "id": "00000000-0000-0000-0000-000000000000", "title": "Example Project", "summary": "Example Summary", "status": "Active", "category_id": 3, "certification_authority_id": 2, "country": "Example Country", "description": null, "goals": null, "images": [ "https://cdn.klimapi.com/projects/00000000-0000-0000-0000-000000000000_1.jpeg", "https://cdn.klimapi.com/projects/00000000-0000-0000-0000-000000000000_2.jpeg" ], "benefits": [ 7, 8, 13 ] } }