Overview¶

SiGREEN API¶

Application Programming Interfaces (APIs) play a critical role in today's interconnected digital landscape. They serve as a bridge between disparate software systems, allowing them to seamlessly communicate and exchange data. APIs are essential for streamlining processes, enhancing collaboration, and driving innovation across industries. By embracing APIs, businesses can unlock new opportunities, improve operational efficiency, and stay ahead in a rapidly evolving marketplace.

Unleash the potential of SiGREEN APIs¶

SiGREEN offers a suite of powerful APIs designed to revolutionize your PCF management practices. With SiGREEN X-Link, you can easily connect your Enterprise Resource Planning (ERP) and Product Lifecycle Management (PLM) systems to SiGREEN.

Seamlessly retrieve critical product, supplier and material data and integrate it into your existing workflows. This streamlined data exchange ensures smooth and efficient product decarbonization efforts.

Unlock the full potential of our SiGREEN API, and experience the convenience of an all-in-one solution for managing product lifecycles and securing your business's future success.

Master Data Management¶

Efficiently synchronize your material, supplier and product master data with SiGREEN.

Product Carbon Footprint¶

Export detailed carbon footprints of your products. Use this information for further analysis, enrich your product data in PLM systems or catalogs, and make data-driven decisions.

Supply Chain Emissions¶

Enhance your materials data by incorporating actual product carbon footprints from your supply chain partners. SiGREEN APIs allow you to export emissions data from sourced components and materials, providing comprehensive insight into the carbon footprint of your supply chain.

Concepts and Glossary¶

For detailed information about the concepts and terminology, please refer to Concepts and Glossary.

Overview of APIs¶

Procurement APIs¶

Supplier APIs ¶

Task	Description
GET	Get supplier by ID for one company in SiGREEN.
PUT	Update a supplier by supplier ID in SiGREEN.
DELETE	Delete supplier by supplier ID in SiGREEN.
GET	Get all suppliers for a company in SiGREEN.
POST	Create a supplier in SiGREEN.

Request PCF APIs ¶

Task	Description
POST	Send PCF request to suppliers in SiGREEN.

Component Secondary Data APIs ¶

Task	Description
GET	Get component secondary data by secondary data ID.
PUT	Update component secondary data by secondary data ID.
GET	Get all component secondary data for component in SiGREEN.
POST	Create secondary data with component.

Supplier Identifier Type APIs ¶

Task	Description
GET	Get supplier identifier types for a company in SiGREEN.
POST	Create a supplier identifier type for a company in SiGREEN.
DELETE	Delete an unused supplier identifier type for a company in SiGREEN.
PATCH	Update a supplier identifier type for a company in SiGREEN.

Component Identifier Types APIs ¶

Task	Description
GET	Get component identifier types for a company in SiGREEN.
POST	Create a component identifier type for a company in SiGREEN.
DELETE	Delete an unused component identifier type for a company in SiGREEN.
PATCH	Update a component identifier type for a company in SiGREEN.

Get Component's PCF APIs ¶

Task	Description
GET	Get an export of a PCF of a component without cryptographic material.
GET	Get the PCF data for your components in SiGREEN.
GET	Get an component average emission.

Suppliers Invitation APIs ¶

Task	Description
POST	Invite supplier to SiGREEN via email.
POST	Cancel supplier invite to SiGREEN.

Component Supplier APIs ¶

Task	Description
GET	Get linked suppliers by componentSupplierLink ID with component.
PUT	Update location/share/secondary data/supplier product ID by component supplier ID.
DELETE	Delete link between component and supplier.
GET	Get all linked suppliers with component.
POST	Link suppliers and secondary data with component.

Components APIs ¶

Task	Description
GET	Get component details by ID.
PUT	Update component details by ID.
DELETE	Delete component by ID.
GET	Get all components for one company in SiGREEN.
POST	Create component in SiGREEN.

Material Categories APIs ¶

Task	Description
GET	Get Material Category details by ID.
PUT	Update Material Categories details by ID.
DELETE	Delete Material Categories details by ID.
GET	Get Material Category image by ID.
PUT	Update Material Category image by ID.
DELETE	Delete Material Category image by ID.
GET	Get all Material Categories for one company in SiGREEN.
POST	Create Material Category to SiGREEN.

Product APIs¶

Product APIs ¶

Task	Description
GET	Get product details by ID.
PUT	Update a product in SiGREEN.
DELETE	Delete a product in SiGREEN.
GET	Get all products of a company in SiGREEN.
POST	Upload a product to SiGREEN.

Product Identifier Type APIs ¶

Task	Description
GET	Get product identifier types for a company in SiGREEN.
POST	Create a product identifier type for a company in SiGREEN.
DELETE	Delete an unused product identifier type for a company in SiGREEN.
PATCH	Update a product identifier type for a company in SiGREEN.

Product PCF APIs ¶

Task	Description
GET	Get product PCF details by ID.
GET	Get the PCF data for your products in SiGREEN.

Factory APIs ¶

Task	Description
GET	Get factories for a company in SiGREEN.
POST	Create a factory for a company in SiGREEN.
DELETE	Delete an unused factory for a company in SiGREEN.
PATCH	Update a factory for a company in SiGREEN.

Bill of Material APIs ¶

Task	Description
POST	Create a Bill of Material for a product in SiGREEN.
GET	Get a list of Bill of Material entries for a product in SiGREEN.
GET	Get a list of BOM versions.

Factory Emissions APIs ¶

Task	Description
POST	Upload factory emissions for a product in SiGREEN.

Offsetting APIs¶

Task	Description
POST	Offset your emissions.

Factory Emissions APIs ¶

Task	Description
POST	Upload factory emissions for a product in SiGREEN.

My Tasks APIs¶

Product Tasks APIs ¶

Task	Description
GET	GET the incoming PCF requests of my company.
PUT	Link product to the task.
DELETE	Delete link between product and task.
PUT	Share the PCF data with the given task.

Component Tasks APIs ¶

Task	Description
GET	GET the outbound PCF requests of my company.
PATCH	Accept proof received to the task in SIGREEN.
PATCH	Reject proof received to the task in SIGREEN.

PCF APIs¶

Product's PCF APIs ¶

Task	Description
POST	To create a TFS standard credential for a specific product of a company in SIGREEN.
POST	To create an ISO standard credential for a specific product of a company in SIGREEN.
POST	To create a CatenaX standard credential for a specific product of a company in SIGREEN.
GET	It is to know whether the credential has been created or not.

Contact¶

For general information about the application, the APIs, any issues or feature requests please contact:

Email: sigreensupport.industry@siemens.com