Getting Started¶
To begin using the Carbon Footprint Indicator for Transportation API, follow these steps:
- Contact our support team to obtain an API Key. You can find our contact information here.
- Include your API Key in the
x-api-keyheader of your HTTP requests.
Note
See the API Specifications for asynchronous (batch) methods.
Example Request¶
API_KEY = your-api-key
# Calculates routing for a shipments and applies emissions reporting.
curl -X 'POST' \
'https://services.supplychainsuitedev.net/publicapi/master/glec_routing_relational/8' \
-H 'accept: application/json' \
-H 'x-api-key: ${API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"Shipments": [
{
"Id": "1",
"Sender_Id": "A",
"Recipient_Id": "B",
"Date": "2023-05-16T18:21:45Z",
"Gross_Weight": 500,
"Weight_Unit_Id": "kg",
"Transport_Mode_Id": "Sea",
"Equipment_Id": "40ft"
}
],
"Locations": [
{
"Id": "A",
"Country": "DE",
"Latitude": 52.52,
"Longitude": 13.40
},
{
"Id": "B",
"Country": "US",
"Latitude": 40.73,
"Longitude": -73.93
}
]
}'