Getting Started

At it’s core, Envase Connect aims to unite Envase clients and Envase systems with relevant data.

There are three main components of Envase Connect which are:

• Events API

• Webhooks API

• Connect API

The Events API allows publishers to create events that any number of subscribers can listen in on and be notified about.

The Webhooks API on the other hand is the component that allows the subscribers to get notified of specific events. They can set rules for what events they want to know about and where they should be notified about the events that took place.

The Connect API is a proxy api that creates a common interface which proxies requests to backend systems such as booking systems.

Events/Webhooks API Use Case

Example

A truck carrying goods for Company A leaves the port and embarks on the road to its final destination. The Envase Connect system using Events API/Webhooks API will be able to notify any stakeholders through a webhook at various legs of the trucks journey - when it left the port, when it picked up the goods, when it entered the final destination yard etc.

Connect API Use Case

Example

A gate providers makes a call to the common Connect API that then determines the correct booking system behind the scenes and validates the booking and returns an approve/reject response.

Authorization/Authentication

All requests require an Authorization token to be provided in the Authorization header as described in the Authorization topic.