Testing
This page reflects the current API behaviour. Some details may change as v3 is finalised.
The sandbox is a safe environment to explore and validate your ekko Climate API integration before going live. It mirrors the production API and SDK behaviour, but no real contributions are processed.
Getting access
- Request testing access from your ekko contact
- Activate your ekko Hub account using the link in your activation email
- Log in to ekko Hub → go to Developer Console
- Generate a new sandbox API key
Your sandbox API key should be used in the Authorization header as a Bearer token for all calls until you move to production. The sandbox base URL is:
https://staging.api.ekko.earth/v3
What you can test
- API integration flow → Create an organisation, generate a carbon quote, allocate funds to a project and trigger a reversal
- Checkout SDK → Create checkout sessions, initialise the SDK with a
clientSecret, render the component and confirm toggle events update your basket totals
Best practices
- Mirror your intended production use cases in sandbox, including success, error and reversal flows
- Use realistic transaction data (currencies, MCC codes, amounts) so footprint calculations are accurate
- Store sandbox identifiers (
quoteId,fundsAllocationId) alongside your own references for reconciliation testing - Check how SDK components behave on desktop and mobile, including slow connections and refresh/back-navigation
Moving forward
Once you’ve validated your flows in sandbox, follow the Go-live checklist to switch to production keys and endpoints.
Updated 14 days ago
What’s Next
Did this page help you?
