Mit der API Emissionen berechnen und Checkout Links zur Kompensation generieren

Mache dich zunächst grundsätzlich damit vertraut wie wir Emissionen berechnen.

Öffne im Dashboard das Entwickler-Menü und navigiere zum Punkt API Keys. Klicke nun auf Neue API Keys hinzufügen. Um Emissionen zu berechnen benötigen deine API Keys Schreiben-Berechtigungen.

Suche nun die für dich passenden Emissionsfaktoren aus unserer Datenbank. Du kannst pro Request an unsere API bis zu 100 sogenannte Calculation Options übergeben.

Nutze nun den Endpunkt /orders/link/calculate, um die Emissionen zu berechnen und mit den berechneten Emissionen Checkout Links zu erstellen.

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.

Wähle mit Hilfe des Header-Parameters X-LOCALE, in welcher Sprache das Ergebnis der API und der Checkout Link zurückgegeben werden sollen.

Übergebe nun die von dir festgelegten calculation_options an die API. Du kannst bis zu 100 calculation_options gleichzeitig berechnen.

Wähle mit den Parametern success_url & cancel_url, wohin der Nutzer des Checkout Links jeweils nach erfolgreicher und abgebrochener Zahlung weitergeleitet werden soll.

Passe den Parameter order_count an, um bis zu 3 Checkout Links mit einem API call zu erhalten.

Standardmäßig runden wir die berechneten Emissionen immer zum nächstgrößeren Kilogram auf. Wenn du eine genauere Berechnung wünschst kannst du einfach fractional_digits nutzen, um die maximale Anzahl der zurückgegebenen Nachkommastellen zu definieren.

In diesem Beispiel berechnen wir die Emissionen einer Fahrt von Berlin nach München und erstellen mit dem Ergebnis einen Checkout Link.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
    "calculation_options": [
        {
            "type": "travel-land",
            "activity": "cars_by_market_segment",
            "specification": "average",
            "detail": "average",
            "value": 2000,
            "unit": "kilometers"
        }
    ],
    "change_allowed": true,
    "success_url": "https://your-business.com/success",
    "cancel_url": "https://your-business.com/cancel",
    "order_count": 1
}

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
32
33
34
35
36
37
38
39
40
41
42
{
    "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
        ]
    },
    "results": [
        {
            "type": "travel-land",
            "activity": "cars_by_market_segment",
            "specification": "average",
            "detail": "average",
            "value": 2000,
            "unit": "kilometers",
            "kgCO2e": 447.26
        }
    ]
}