Emission Clusters
Register API keys and retrieve emissions grouped under custom cluster names.
Register Key
Registration enables you to get the key and use the function to cluster emissions, using self-defined labels. Register with your email address and a password to get a unique key, which can be used as Bearer Token in emission calculations along with cluster-name.
Register Key › Request Body
emailpasswordcompany_nameRegister Key › Responses
API key registration result.
CarbonSutra_API_KEYSecret CarbonSutra API key. Store securely.
successstatusCluster Data
Emissions can be grouped into self-defined clusters and retrieved using those labels. This eliminates the need to store the results at developer's end. A key will need to be generated, which is then passed as a Bearer Token (within Authorization) in all calculations, so that the user can be identified and the results are securely delivered.
Use the POST API of RegisterKey to obtain your API_KEY which will be used in all estimation calculations for which clustering is required. Your email address and a secret phrase (password) will be required to generate this key.
The POST API of RetrieveKey will give you the key again if it was misplaced, as long as the correct password is entered.
Note that if clustering is not needed then you do not need API_KEY.
The GET API of ClusterData returns all the estimations that were calculated for a specific cluster_name.
query Parameters
cluster_nameSelf-Defined Name of Cluster
Cluster Data › Responses
Emission records belonging to the cluster.
Generate OpenCCF Emissions Report
Generates an OpenCCF-compliant emissions report using emission calculations associated with the supplied cluster name and report configuration.
Generate OpenCCF Emissions Report › Request Body
cluster_nameName of the emission cluster containing the calculations.
Configuration metadata for the OpenCCF emissions report.
Generate OpenCCF Emissions Report › Responses
OpenCCF-compliant emissions report generated successfully.
