# EcoTransIT World REST-Api

## General Information
This is the complete specification of the EcoTransIT World Rest Api 
**Please note:** in order to try out the API you need to [contact our team](https://www.ecotransit.org/en/contact/) to get a test account.
## Authorization
If you are already a customer or have a test account see your instance of swagger-ui
https://customer-name.ecotransit.org/swagger-ui (replace *customer-name* with your company name or the test server name)
for details on authorization and how to send your first request to the REST API!

Version: 8.4.0
License: IVE Legal notice

## Servers

```
https://customer-name.ecotransit.org
```

## Security

### oAuth2AuthorizationCode

This API uses OAuth 2 with the Authorization Code flow.

Type: oauth2
Authorization URL: https://customer-name.ecotransit.org/realms/ETW/protocol/openid-connect/auth
Token URL: https://customer-name.ecotransit.org/realms/ETW/protocol/openid-connect/token
Scopes:
- `openid`: add Description
- `offline_access`: OpenID Connect built-in scope

## Download OpenAPI description

 - [EcoTransIT World REST-Api](https://rest-api.ecotransit.world/_bundle/apis/OpenApi.yaml)

## calculate transport

 - [POST /etw-rest/calculateTransport](https://rest-api.ecotransit.world/apis/openapi/calculate-transport/calculatetransport.md): request for emission calculations
 - [GET /etw-rest/calculateTransport/kml](https://rest-api.ecotransit.world/apis/openapi/calculate-transport/calculatetransportkml.md): generates a google earth kml file of the routing for the provided request uuid
## collection and delivery

 - [POST /etw-rest/calculateCollectionAndDelivery](https://rest-api.ecotransit.world/apis/openapi/collection-and-delivery/calculatecollectionanddelivery.md): calculate a collection and delivery round ("milkrun") from json input
## Info

 - [GET /etw-rest/getVersion](https://rest-api.ecotransit.world/apis/openapi/info/getversion.md): Returns the current version of the etw-rest api