Skip to main content

Carbon API

Welcome to the Carbon API documentation from Satuplatform.
The Carbon endpoints provide access to calculate carbon emissions based on specific activities. All requests must be authenticated using Basic Authentication.

Authentication​

To access Carbon endpoints, you need to authenticate using the Basic scheme.
Use a Base64-encoded combination of your apiKey:apiSecret.

Headers​

HeaderValue
Content-Typeapplication/json
AuthorizationBasic <base64(apiKey:apiSecret)>

Replace <environment> in the URL with:

  • api for production
  • api-sandbox for sandbox

URL​

  • Production:
    https://api.satuplatform.com/api/v1/

  • Sandbox:
    https://api-sandbox.satuplatform.com/api/v1/

You can switch between environments by changing the <environment> value in your application or integration settings.

General Format​

  • Method: POST
  • Content-Type: application/json
  • Authentication: Required via Authorization: Basic <base64(apiKey:apiSecret)>

Notes​

  • All requests and responses use JSON format.
  • Ensure your apiKey and apiSecret are securely stored and not shared.
  • Use the /token endpoint first to obtain your API credentials.

If you encounter any issues or need further assistance with the Carbon API, please contact our support team.