Back to bcome.biz

API Parameter Communication: User Guide for Effective Integration

API Response Data Insights

The API generates results based on the parameters provided in the request. Below is an example of how the response is structured:

  • PLM
  • LCA
  • Eco-Score
  • CEI
  • Others

How to Communicate the API Parameters Effectively

⚠️ Notice: To use all this data, it is mandatory to include the following key elements in your design:

  • Units (ex: kg CO2 eq, g phosphates eq, etc…) following each number: 1,2 does not mean nothing if we don’t know if it is 1,2 gram or kilogram.
  • Version version: the results of the API will change from one version to the other, add it to the design so that your end-user is not misled.
  • Analysis based on functional_unit: your end-users need to know if your results are presented for 1 unit, for 1 pair or for 1 set.
  • Powered by BCome: it is always better to communicate who is your data provider to enhance transparency. The proposed link redirects the user to our website to obtain information about the methodology.

PLM

Traceability insights | Product journey facts.

IndicatorDefinitionExample
processesAverage number of processes the article has gone through.39 processes
supplier_traceability_rateScore based on known suppliers by raw material, material and article.81% supplier traceability
suppliersSuppliers declared by article.7 suppliers declared
km_traveledAverage distance in kilometers traveled by the product from raw material to warehouse.21819.47 km from origin to warehouse
material_processing_originMain material processing country.Material processing: Spain
article_finishing_originMain article finishing country.Article finishing: Italy
article_manufacturing_originMain article manufacturing country.Article manufacturing: Tunisia

LCA

Environmental assessment | Cradle-to-gate analysis.

IndicatorDefinitionExample
water_scarcityWater scarcity impact of the article. Deprivation of water to humans and ecosystems due to water consumption in the product value chain.Water scarcity
1.53
m3 water eq consumed
water_scarcity_savingsAverage percentage of water scarcity savings in all production compared to the industry standard.Water scarcity
Contributes to 71% less m3 water eq consumed
water_scarcity_equivalencem3 water equivalent to 1,5 l water bottle(s).Water scarcity
23.82
bottles
global_warmingClimate change caused by the greenhouse effect of heat-trapping pollutants released from the product value chain.Global warming
4.22 kg CO2 eq emitted
global_warming_savingsAverage percentage of global warming savings in all production compared to the industry standard.Global warming
Contributes to 68% less kg CO2 eq
global_warming_equivalencekg CO2 equivalent to days of use of a LED light bulb.Global warming
211.15
days a bulb is on
eutrophicationProliferation of algae into an ecosystem due to the excess release of phosphates and nitrates in the product value chain.Eutrophication
3.51 g phosphates eq emitted
eutrophication_savingsAverage percentage of eutrophication savings in all production compared to the industry standard.Eutrophication
Contributes to 68% less g phosphates eq
eutrophication_equivalenceg phosphates eq equivalent to complete washing cycles in a laundry.Eutrophication
0.65
washing cycles
abiotic_depletionUse of fossil fuels such as oil, natural gas, and coal for the production of energy consumed in the value chain.Abiotic depletion
61.64 MJ consumed
abiotic_depletion_savingsAverage percentage of abiotic depletion savings in all production compared to the industry standard.Abiotic depletion
Contributes to 70% less MJ
abiotic_depletion_equivalenceMJ equivalent to km traveled in a regular car.Abiotic depletion
13.93 km driven

Eco-Score

Eco-Score | Sustainability performance index.

IndicatorDefinitionExample
planet_scoreScore based on practices for environmental efficiency and responsible use of resources.Planet
B
planet_qualificationPlanet performance scored out of 10.Planet
7.14
/ 10 points
people_scoreScore based on practices created to ensure safe and ethical work, social and animal conditions.People
A
people_qualificationPeople performance scored out of 10.People
8.4
/ 10 points
transparency_scoreScore based on the practices and the commitment to monitoring, defining, and ensuring transparency in the value chain.Transparency
C
transparency_qualificationTransparency performance scored out of 10.Transparency
6.95
/ 10 points
circularity_scoreScore based on practices established to ensure resource loops are closed and valuable materials are recovered.Circularity
A
circularity_qualificationCircularity performance scored out of 10.Circularity
9.13
/ 10 points

CEI

Circularity insights | Circular economy analysis.

IndicatorDefinitionExample
material_circularity_indicatorScore based on the circularity of material flow in the item’s lifecycle and its usage duration and intensity compared to industry standard.74% circular based on MCI score (Ellen MacArthur Foundation)
recycled_contentProportion of materials included in the product derived from recycled sources.100% of recycled content
total_unrecoverable_wasteWaste generated throughout the lifecycle of the item, which will be disposed of in landfills or incinerated.0,58 kg of waste no longer recoverable
utility_percentageDerived from the duration and intensity of use of an item compared to an average product in the industry of the same type.75% usage potential improvement based on eco-design best practices

Others indicators

IndicatorDefinitionExample
versionThe impacts displayed depend on the version of the analysis. Impacts from different versions are not comparable.Version 1.6
project_nameAW24
functional_unitThe functional unit allows the end-user to understand the scope of the analysis. Impact calculated for 1 unit, 1 pair, 1 set, etc…Analysis based on 1 unit
nameTop Nathan
referenceGA1644103

Frequent Communication Mistakes

Follow these tips to avoid common communication errors and ensure your message is clear, concise, and effective in any context:

1. Always keep the unit of measurement and “eq”.

  • For example: “This t-shirt has consumed 29,03 m3 water eq.

2. Mention the indicator being referenced and don’t use alternative indicators. For example:

  • For example: “This t-shirt has contributed to water scarcity through the consumption of 29,03 m3 water eq.

For more information, we recommend reading our Do’s and don’ts in data communication guide.

Designing E-commerce with API Data

Learn how to leverage API data to create stunning website designs. Be inspired and maintain transparency by showcasing valuable insights.


Related articles

How to Integrate via API Platform

How to integrate the e-commerce in your website

How to integrate through SPA platform