Mit der API Emissionen berechnen, Angebote für Kompensationen erhalten und annehmen

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/pending/calculate, um die Emissionen zu berechnen und Angebote zur Kompensation zu erhalten. Nutze dann /orders/{order_id}/process um ein Angebot zu bestätigen.

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.

Übergebe mit dem Parameter recipient_name einen Namen für das Zertifikat. Das kann sowohl eine Person als auch ein Unternehmen sein. Mit dem Parameter recipient_email kannst du eine E-Mail Adresse übergeben, an welche wir das Zertifikat für die Kompensation senden. Mit dem Parameter send_at kannst du das versenden des Zertifikats um bis zu 3 Tage verzögern.

Passe den Parameter order_count an, um bis zu 3 Angebote zur Kompensation 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 ersten Beispiel berechnen wir die Emissionen einer Fahrt von Berlin nach München und lassen uns 2 Angebote zur Kompensation geben. Im zweiten Beispiel nehmen wir dann das erste der beiden Angebote an, um die berechneten Emissionen zu kompensieren.

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "calculation_options": [
        {
            "type": "travel-land",
            "activity": "cars_by_market_segment",
            "specification": "average",
            "detail": "average",
            "value": 2000,
            "unit": "kilometers"
        }
    ],
    "order_count": 2
}

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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
{
    "pending_orders": [
        {
            "order_id": "CA-0000-00000000",
            "status": "pending",
            "price": 10,
            "currency": "EUR",
            "kgCO2e": 448,
            "metadata": {},
            "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
                ]
            }
        },
        {
            "order_id": "CA-0000-00000001",
            "status": "pending",
            "price": 10,
            "currency": "EUR",
            "kgCO2e": 448,
            "metadata": {},
            "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
        }
    ]
}

1
2
3
4
{
    "recipient_name": "Test Customer",
    "recipient_email": "test-order@klimapi.com"
}

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
{
    "order_id": "CA-0000-00000000",
    "status": "processed",
    "certificate_issued_at": "2024-06-06T20:22:32.407Z",
    "certificate_url": "https://certificates.klimahelden.eu/CA-0000-00000000",
    "certificate_pdf": "https://certificates.klimahelden.eu/certificate/download?locale=en&order_id=CA-0000-00000000",
    "price": 10,
    "currency": "USD",
    "kgCO2e": 500,
    "metadata": {},
    "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
        ]
    },
    "recipient": {
        "name": "Test Customer",
        "email": "test-order@klimapi.com"
    }
}