Mit der API Emissionen kompensieren

Entdecke, wie du API-Keys anlegst und die API nutzt, um feste Beträge oder CO2-Emissionen direkt zu kompensieren und Kompensationszertifikate zu versenden.

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 Privaten Key gut ab und gebe ihn niemals an dritte weiter!

API anfragen

Nutze nun den Endpunkt /orders/process/carbon, um eine fixe Summe CO2 Emissionen zu kompensieren oder nutze den Endpunkt /orders/process/price, um einen fixen Betrag in der gew√ľnschten W√§hrung zu kompensieren.

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.

Zertifikats-Empfänger

√ú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.

Beispiele

500kg CO2e kompensieren

POST/v2/orders/process/carbon

1
2
3
4
5
{
    "kgCO2e": 500,
    "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:38:20.548Z",
    "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": 8.87,
    "currency": "EUR",
    "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"
    }
}

F√ľr 10 Euro kompensieren

POST/v2/orders/process/price

1
2
3
4
5
{
    "price_amount": 10,
    "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-01-01T00:00:00.000Z",
    "certificate_url": "https://certificates.klimahelden.eu/CA-0000-00000000",
    "certificate_pdf": "https://certificates.klimahelden.eu/certificate/download?locale=en&order_id=0000-00000000",
    "price": 10,
    "currency": "EUR",
    "kgCO2e": 576,
    "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"
    }
}

Keine Kreditkarte erforderlich - Erstelle dir jetzt einen Account

Erstelle ein Konto und beginne direkt mit der Berechnung und Kompensation der CO2-Emissionen √ľber unsere API. Du hast noch Fragen oder ben√∂tigst ein individuelles Angebot? Nutze den Chat oder vereinbare direkt einen Termin mit unserem Sales-Team.