Introduction

Welcome to the WasteHero API v3, a RESTful web service that allows developers to integrate and interact with WasteHero's platform and customize/personalize the experience and values that WasteHero provides.

This documentation, as well as the API, was written to help our customers in the process of integrating the API into individual projects. Therefore, for ease of use, this document is split into two parts - guides and references.

You are currently reading the guides, where you will be walked through how to use the API and shown its possibilities.

The references section can be found in the top bar under the API reference name and contains the technical specifications for the API. If you are a developer who is not sure which endpoints to call, that's what you want to check out.

Going back to the API itself, all information/data is being exchanged between a user and the API in JSON format over a secure HTTPS connection. Every call to the API requires a header with the API key (the authentication is described in more detail under the dedicated section). Certain GET requests also require a path parameter - mainly in the form of ID, but do not require any additional header parameters or data provided in the request body. On the other hand, the POST, PUT and DELETE requests often require header parameters, request body or in some cases query parameters send with the API call.

However, there is nothing to worry about because this documentation will make clear which fields are required, which fields are optional and how to provide the data when sending the API request or calling a particular endpoint.

๐Ÿ“˜

Documentation Examples

All examples of the requests in this documentation are formatted for Python, but of course, the API can be integrated with any other language.

๐Ÿ“˜

Testing the API - Postman

Especially at the beginning, many developers want to test out the API and its functionality without having to code the requests themselves. For that, we recommend using Postman, which is an API platform for building and using APIs in a fast and simple way with the help of GUI.

Postman can be found here Postman API Platform

If there are any questions regarding the API, use cases that are not covered by the documentation, or you have found a bug that you would like to report, write us an email at [email protected] and tell us what can be fixed or improved.


Whatโ€™s Next

If you would like to learn more about the authentication process required for sending the requests, click on the first link below.

Otherwise, if you would like to jump straight to action, you can go to Routes (second link) or Tickets (third link).

The last link will carry you through the rest of the Introduction section.