Generate LCA Report from Raw Product Data
This page shows an example on calling EmVide API using your EmVide username and base64 encoded password to generate a full LCA report and get it sent back to you or your customer email.
Endpoint: Create Product Lifecycle Assessment from Raw Data (POST)
Authorisation Header: Username + Base64 password or JWT token
This endpoint allows the client to submit a new product lifecycle assessment for evaluation. The request includes detailed information about the product, its components (BOM - Bill of Materials), and related lifecycle assessment parameters.
Request Body
The request body should be sent as JSON and contains the following fields:
Product Object
name (string, required): The name of the product.
productName (string, required): The name of the product (same as
name
).productType (string, required): The type of product.
description (string, optional): A brief description of the product. Excluding processes.
extendedDescription (string, optional): A more detailed description of the product, including specific manufacturing processes. This information is used to extract process information and enrich your BOM.
image_url (string, optional): URL of the product image.
lifeTime (string, optional): The expected lifetime of the product.
resource_type (string, required): Interim or Finished.
customer_contact (string, required): The contact person for the product at the customer's organization.
customer_email (string, required): The email address of the customer.
customer_organisation (string, required): The name of the customer's organization.
disclosing_gases (string, optional): The gases being disclosed in the lifecycle assessment.
lcia_method (string, required): The Ecoinvent method used for the lifecycle impact assessment (LCIA).
lcia_model (string, required): The Ecoinvent model used for the lifecycle impact assessment.
purpose (string, required): The purpose of the lifecycle assessment.
reporting_period (string, optional): The period during which the lifecycle assessment is being reported.
service_life_time (string, optional): The service life time of the product.
unit_of_analysis (string, required): The unit of analysis for the lifecycle assessment.
email_to_customer (boolean, optional): Flag indicating if the report should be emailed to the customer (customer_email) or the EmVide user (you).
BOM (Bill of Materials) Object
The BOM (Bill of Materials) is an array of objects where each object represents a component of the product. All objects must contain the same sub objects (just like a CSV). Use any naming conventions and pass as little or as much information as you have. EmVide will use AI to fill and enrich your data.
Name (string, required): The name of the component part.
Quantity (integer, required): The quantity of the part used in the product.
.... any other information you have (e.g., unit of measurement, supplier address, description, more details, etc..)
Each entry in the BOM should follow the above minimal structure.
Response
200 OK: The product lifecycle assessment has been successfully created and stored.
400 Bad Request: The request body is invalid or missing required fields.
500 Internal Server Error: An error occurred on the server while processing the request
Request Example
Example Response
Last updated