Preparation
First of all, familiarize yourself with how we Calculate emissions.
Create an API key
Open the developer menu in the dashboard and navigate to API Keys. Now click on Add new API keys. To calculate emissions, your API keys require write permissions.
Important: Save the private key and never pass it on to third parties!
Find suitable factors
Now find the right emission factors for you from our database. You can submit up to 100 calculation options per request to our API.
Make an API Request
Now use the endpoint /orders/link/calculate
to calculate the emissions and create checkout links with the calculated emissions.
Good to know: You can also use our PHP Library or Node.js Library to interact with the API.
Options
Currency
Use the header parameter X-CURRENCY
to select the currency in which the result of the API and the checkout link should be returned. There are over 100 currencies to choose from.
Language
Use the X-LOCALE
header parameter to select the language in which the result of the API and the checkout link should be returned.
Calculation Options
Now transfer the calculation_options
you have defined to the API. You can calculate up to 100 calculation_options
at the same time.
Success & Cancel URLs
Use the success_url
& cancel_url
parameters to select where the user of the checkout link should be redirected after a successful and canceled payment.
Order Count
Adjust the order_count
parameter to get up to 3 checkout links with one API call.
Fractional Digits
By default, we always round up the calculated emissions to the nearest kilogram. If you want a more precise calculation, you can simply use fractional_digits
to define the maximum number of decimal places returned.
Example
In this example, we calculate the emissions of a trip from Berlin to Munich and create a checkout link with the result.
POST/v2/orders/link/calculate
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 } ] }