Endpoints structure
The general structure of the API endpoints could be divided into three main groups, shown below.
Endpoint | |
---|---|
https://platform-api.wastehero.io/api/v3/ | The core structure of each endpoint that is used to create all the endpoints by appending the valid information as the path parameters. |
https://platform-api.wastehero.io/api/v3/route | The general endpoint for a particular element - in this case a route. This endpoint could be used to, for example, get all the routes. |
https://platform-api.wastehero.io/api/v3/route/{route_id} | The specific endpoint for a particular element - in this case a route. This endpoint could be used to, for example, get information only of a specific route. |
Note, that even if the endpoints shown above are the most common ones, you could encounter an endpoint that looks like this https://platform-api.wastehero.io/api/v3/route/{route_id}/{stop_id}/complete
and is completely valid for certain types of requests.
The endpoints were written in a way that should convey the usage of the endpoint just by looking at it, however, if you are not sure what the endpoint does, check it on the API Reference page.
Updated over 2 years ago