Getting started
This API allows users to interact with the Emitwise system and perform various operations.
The Emitwise API provides functionality for:
- Retrieving data from the Emitwise system
- Sending data to the Emitwise system
Requesting access
Please request access to our API by contacting your Emitwise CSM. Once the request has been processed, continue onto the below sections.
Authentication
To authenticate with the Emitwise API, you need to create a new API key in your Company settings. Follow these steps:
- Log in to your Emitwise account.
- Go to Company settings.
- Navigate to the API Keys section.
- Click on "Create New API Key".
- Provide a name for your API key and click "Create".
Remember to keep your API key and secret secure and avoid sharing it publicly. If you suspect that your API key has been compromised, you can regenerate it in your Company settings.
By authenticating with your API key, you can securely access and interact with the Emitwise API to manage your emissions data and perform various operations.
Facilities
Facilities are specific places or areas that are relevant to your application or system. They can represent physical locations, such as offices or factories, or virtual locations, such as business units.
When working with the Emitwise API, you can use locations to track and manage emissions data associated with different areas of your organization. Each facility can have its own set of emissions data, allowing you to analyse and report on emissions at a granular level.
By organizing your emissions data into different facilities, you can gain insights into the environmental impact of specific areas within your organization and take targeted actions to reduce emissions.
Projects
Projects in the Emitwise API represent specific initiatives or activities within your organization that are related to emissions tracking and management. They allow you to group emissions data and analyze the environmental impact of different projects.
By organizing your emissions data into different projects, you can track the progress and effectiveness of specific sustainability initiatives and make data-driven decisions to achieve your environmental goals.
Schema
The schema in the Emitwise API defines the structure and format of the data that can be stored and managed. It specifies the fields, data types, and relationships between different entities.
To retrieve the schema information, you can make a GET request to the /schema endpoint of the Emitwise API. This endpoint will return a JSON response containing the schema definition.
The schema provides a blueprint for organizing and managing your emissions data. It helps ensure consistency and integrity of the data by enforcing predefined rules and constraints.
By understanding the schema, you can effectively work with the Emitwise API and leverage its capabilities to analyze and report on emissions data in a structured manner.
Files
Files represent the activity data you want to calculate emissions for. The file must be in tabular format and match our schema.
To upload a new file, you can make a POST request to the /files endpoint of the Emitwise API. This endpoint accepts the file data as a request parameter, along with any other relevant details.
Once a file is uploaded, you can retrieve its details, update its information.
By organizing your emissions data into different files, you can easily manage and analyze the environmental impact of specific data sources or documents within your organization.
Suppliers
Suppliers are the entities that provide goods or services to your organization. They can be companies, individuals, or other organizations that you do business with. They are automatically identified from your spend data.
By default, every unique supplier description is considered a new supplier. However, we allow mapping multiple supplier descriptions to a single supplier. This is currently possible by contacting Emitwise support.
To retrieve aggregated supplier data, you can use the paginated POST /suppliers/list endpoint. This endpoint accepts a JSON payload with parameters to control the pagination and filtering of the results.