Integration Guide

This guide describe the process to integrate Envase Trace with your application. It provides detailed information about how a client application should communicate with Envase Connect Data to publish trace events and receive results. It also describes the structure of the payloads for those events, and the results the service will provide.

Important

There has been some documentation floating around on how the payloads look like. These documents were initial drafts, and they are superseded by this documentation. This guide should be consider the single source of truth to integrate your application with Envase Trace.

Envase Trace provides two major services to trace container status. The Container Availability service provides functionality to trace the status of a container as it arrives to a destination terminal or rail, and provides information about when the container is available for pickup. The Export Booking service provides information about an export booking that may contain multiple export containers, and provides information about when containers can be delivered to a terminal or rail.

The system requirements and architecture for both services are similar. The following sections will provide information to help you with the integration and will describe the specifics of each service.

The following sections provide more detailed information about integrating these services with your application:

Contents:

• Integrating Envase Trace Overview
• Envase Trace Environments
• Authentication/Authorization Process
• Registering Web-Hooks with Envase Connect Data
• Container Availability Integration
• Export & Empty Containers Integration
• Export Booking Integration
• Appointments Integration
• Truck Visit Appointments Integration