Emvide Knowledge Base
  • Emvide Documentation
  • Welcome to Emvide
  • Common FAQs
  • Emvide Platform Usage
    • The Emvide Platform - Overview
    • Home Dashboard and Analytics
    • Product Portfolio
    • Analysis Building Blocks
    • Using the Canvas
    • User and Account Management
    • Accessing the Help Desk and Support
  • Emvide Co-pilot
    • Your LCA Co-Pilot
    • End-to-End LCAs with Co-Pilot
      • Co-Pilot Stage 1: Data Preparation
      • Co-Pilot Stage 2: AI-Powered LCA
      • Co-Pilot Stage 3: Validate Assumptions
      • Co-Pilot Stage 4: Rapid Reporting
    • Using AI in the Platform Wizards
      • Co-Pilot Playground
      • Co-pilot in Resource Nodes
      • Co-pilot in Process Nodes
      • Co-pilot in Reporting
  • Best Practice Guidance
    • Best Practice Guidance - Overview
    • BOM to csv Best Practice
  • Core Methodologies and Practices
    • Welcome to the Core Methodologies and Practices
    • 1. Methodological Approach
    • 2. Data Collection and Quality Assurance
    • 3. Allocation Methods
    • 4. Standards and Compliance
    • 5. Cut-Off Criteria
    • 6. Assumptions and Limitations
  • Embodied Emissions in Products and Services
    • Greenhouse Gases (GHG) - A Driver for Change
    • GHG Scopes - Where Products fit in reporting?
    • Product Emissions - A Definition
    • Some Basic Rules for Emissions Measurement
    • Emissions Measurement Examples
    • How to Unlock Accurate Product Emissions?
  • The Lifecycle Assessment Method
    • Introduction to LCAs
    • Global Standards and Protocols
    • The Lifecycle Assessment Method
      • 1. Defining the Scope and Goal of Your LCA
      • 2. Understand and Document your Scope and Value Chain Process
      • 3. Compile Your Inventory
      • 4. Calculate your Emissions
      • 5. Develop Inventory Results
      • 6. Conduct Impact Assessment
      • 7. Interpretation and Reporting
      • 8. Verification
      • 9. Continuous Improvement
    • Worked Example
    • Additional LCA Resources
  • Emvide Value (Proposition and Pricing)
    • Overview
    • The Emvide Value Offering
    • How does Emvide pricing work?
    • How much does Emvide cost?
    • Emvide Commercial Tiers
    • LCA as a Service (LCAaaS)
    • Emvide Educational Licences
    • Partnership Programme
    • Ways to Pay for Emvide
    • Getting Onboard - Pilots and Trials with Emvide
    • Emvide Support Services and Pricing
    • FAQs - Pricing and Account Usage
  • EmVide API
    • Generate LCA Report from Raw Product Data
Powered by GitBook
On this page
  1. EmVide API

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)

https://portal.emvide.com/api/products-copilot/addFromRawBomAndEmailLca

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

{
 "product": {
  "customer_contact": "Amir Kotb",
  "customer_email": "amir@riskoa.com",
  "customer_organisation": "Riskoa",
  "description": "The TrailMaster 5000 is crafted for adventure enthusiasts seeking thrilling off-road experiences. Featuring high-quality components such as lightweight yet durable rims, superior braking systems, and a rugged frame built for rough terrains, the TrailMaster 5000 combines comfort with durability. Its ergonomic saddle and advanced shock absorbers ensure maximum comfort during long rides, while the precision cogset and derailleur provide seamless gear shifting.",
  "extendedDescription": "The TrailMaster 5000 is crafted for adventure enthusiasts seeking thrilling off-road experiences. Featuring high-quality components such as lightweight yet durable rims, superior braking systems, and a rugged frame built for rough terrains, the TrailMaster 5000 combines comfort with durability. Its ergonomic saddle and advanced shock absorbers ensure maximum comfort during long rides, while the precision cogset and derailleur provide seamless gear shifting. This multi-component bicycle is manufactured using only two processes: Process 1 (Assembly): The frame is constructed by joining key structural components like the head tube, top tube, and seat tube to ensure durability and integrity. Process 2 (Adjustments): The installation and precise adjustment of mechanical components such as the brakes, derailleurs, and drivetrain, along with the wheels. ",
  "disclosing_gases": "CO2",
  "image_url": "https://m.media-amazon.com/images/I/81DPZ3XfrwL._AC_UF894,1000_QL80_DpWeblab_.jpg",
  "lcia_method": "EF v3.1",
  "lcia_model": "cutoff",
  "lifeTime": "5 years",
  "name": "Trailmaster_un",
  "productName": "Trailmaster_un",
  "productType": "finished",
  "purpose": "The primary objective of the Life Cycle Assessment (LCA) study is to comprehensively evaluate the environmental impacts associated with every stage of the product lifecycle, from raw material extraction through manufacturing, distribution, usage, and eventual disposal. This analysis aims to pinpoint areas where the company can effectively reduce its environmental footprint and optimize resource efficiency, aligning with its broader commitment to sustainability. The findings from the LCA will inform product design enhancements, leading to the creation of more sustainable and cost-effective offerings. Additionally, the LCA will assist the company in meeting regulatory compliance and satisfying the increasing consumer demand for environmentally friendly products. Ultimately, this initiative will position the company as a leader in environmental stewardship, while simultaneously improving operational efficiency and strengthening its competitive edge in the market.",
  "reporting_period": "Q3 2024",
  "resource_type": "finished",
  "service_life_time": "5 years",
  "unit_of_analysis": "unit",
  "email_to_customer": false
 },
 "bom": [
   {
     "Part Name": "Spokes",
     "Part Number": "N0453",
     "Quantity": 36,
     "Supplier Address": "123 Bike Lane, London, UK"
   },
   {
     "Part Name": "Hub",
     "Part Number": "N0461",
     "Quantity": 2,
     "Supplier Address": "456 Gear Drive, Toronto, Canada"
   },
   {
     "Part Name": "Wheel",
     "Part Number": "N0473",
     "Quantity": 2,
     "Supplier Address": "789 Cycle Street, Sydney, Australia"
   },
   {
     "Part Name": "Saddle",
     "Part Number": "VW0411",
     "Quantity": 1,
     "Supplier Address": "987 Seat Ave, Cape Town, South Africa"
   },
   {
     "Part Name": "Seat Post",
     "Part Number": "VW0412",
     "Quantity": 1,
     "Supplier Address": "123 Bike Lane, London, UK"
   },
   {
     "Part Name": "Handle grip",
     "Part Number": "CV0612",
     "Quantity": 2,
     "Supplier Address": "456 Gear Drive, Toronto, Canada"
   },
   {
     "Part Name": "Shock Absorber",
     "Part Number": "BK8920",
     "Quantity": 1,
     "Supplier Address": "789 Cycle Street, Sydney, Australia"
   },
   {
     "Part Name": "Brakes",
     "Part Number": "BK8956",
     "Quantity": 2,
     "Supplier Address": "321 Wheel Road, Munich, Germany"
   },
   {
     "Part Name": "Fork",
     "Part Number": "BK8025",
     "Quantity": 1,
     "Supplier Address": "654 Valve Way, Tokyo, Japan"
   },
   {
     "Part Name": "Tube",
     "Part Number": "BK8056",
     "Quantity": 4,
     "Supplier Address": "987 Seat Ave, Cape Town, South Africa"
   },
   {
     "Part Name": "Seat Stay",
     "Part Number": "BK7459",
     "Quantity": 2,
     "Supplier Address": "321 Wheel Road, Munich, Germany"
   },
   {
     "Part Name": "Chain Stay",
     "Part Number": "BK7460",
     "Quantity": 2,
     "Supplier Address": "654 Valve Way, Tokyo, Japan"
   },
   {
     "Part Name": "Cogset",
     "Part Number": "BK6478",
     "Quantity": 1,
     "Supplier Address": "123 Bike Lane, London, UK"
   },
   {
     "Part Name": "Derailleur",
     "Part Number": "BK6415",
     "Quantity": 2,
     "Supplier Address": "456 Gear Drive, Toronto, Canada"
   },
   {
     "Part Name": "Chain",
     "Part Number": "BK5563",
     "Quantity": 1,
     "Supplier Address": "321 Wheel Road, Munich, Germany"
   },
   {
     "Part Name": "Pedal",
     "Part Number": "BK5593",
     "Quantity": 2,
     "Supplier Address": "987 Seat Ave, Cape Town, South Africa"
   },
   {
     "Part Name": "Crank Arm",
     "Part Number": "BK5518",
     "Quantity": 2,
     "Supplier Address": "123 Bike Lane, London, UK"
   }
 ]
}

Example Response

{
    "status": "success",
    "message": "Product creation initiated."
}
PreviousFAQs - Pricing and Account Usage

Last updated 9 months ago