All endpoints of this API are secured and require proper authentication to access. To ensure that only authorized users can execute requests, the API employs an API key-based authentication mechanism.

API Key

To interact with any endpoint, you must include an authorization header in your request. The header should have a key named X-API-Key, with the value being your API key. The API key is a unique identifier generated specifically for the environment that you are working in.

Important Notes

• Mandatory Header: The X-API-Key header is mandatory for all API requests. Requests without this header, or with an incorrect API key, will be rejected with a 403 Forbidden status code and message “Api Key is required.” if no API key was provided with the request or “Api Key is invalid.” if the provided API key is invalid or in an Inactive state.

• Environment-Specific Keys: Ensure you are using the correct API key for the respective environment. Using a key from a different environment will result in an authorization failure.

  • For Production environment

    • All API keys should be issued from https://portal.treebytree.earth and used for requests to https://integration-api.treebytree.earth