The Earthster API uses the OpenAPI standard with the REST architecture, allowing you to create a seamless data exchange between Earthster and your other applications.
Benefits of using the Earthster API
Automate cycle updates
Keep your cycles up to date with your applications (e.g. an ERP system)
Create custom dashboards (e.g. PowerBI)
The API requests are user specific and requires a Corporate plan.
Start using the Earthster API
With the Earthster API you are able to query any data that your user has access to (when the API feature is enabled for your user).
Quick guide:
Activate the API connection:
Contact us at [email protected]
Create your unique API token (Bearer token):
In Earthster go to: Main menu -> API -> Create new token
Alternative: Create the token from your own system
Set up your system to do API requests
Include the token in the header to authenticate your requests
Enjoy seamless data exchange between Earthster and your applications
Authentication
The Earthster API uses Bearer tokens to authenticate requests. You can view and manage your API tokens in the "My Profile" section.
Go to: Main menu -> API -> Create new token
The Bearer token is user specific, therefore it grants you access to any data that your user has at least view access to.
Alternative: Create the token from your own system
Add a POST type HTML request for authenticating
Required fields:
email
password
Example content in Body:
email=test%40earthster.org&password=test-my-password
Doing API requests
Authenticate all your API requests with the Bearer API token that you have generated in Earthster or from your own system.
Earthster uses conventional HTTP response codes to indicate the success or failure of an API request.
Base URL
https://app.earthster.org
Available endpoints
For more details download the technical documentation.
Name | Endpoint | Available request types | Description |
Account | /api/v1/accounts | GET | Lists the accounts the user has access to. |
Auth | /api/v1/auth | POST | Create a Bearer token. |
Comparison | /api/v1/comparisons | GET | Lists all the comparisons the user has access to. |
Cycle | /api/v1/cycles | GET | Lists all the cycles the user has access to. |
Process | /api/v1/cycles/{cycle_id}/processes | GET PUT | Fetch and update process values for a particular cycle. |
Release | /api/v1/cycles/{cycle_id}/releases | GET | Shows release data for a particular cycle. |
Me | /api/v1/me | GET | Gives information about your own profile. |