API Documentation

Owned by April Hickson
Last updated: 23 Feb, 2024 by Chris Boxall
3 min read

 

Contents

What is the PortConnect API?

The PortConnect API (Application programming interface) is a new, more modern way of sending and retrieving data from PortConnect.  PortConnect receives container event information 24 hours a day from our partner ports Ports of Auckland, Port of Tauranga, Timaru Container Terminal and Lyttelton Port Company.  Events are received at least every ten minutes.

Our APIs include:

  • Scheduled vessels: Returns scheduled vessel information, including expected time of arrival and departure.

  • Vessel Schedule Event Subscriptions: Receive real-time alerts for key vessel information, including changes to ETA and details of vessels omitting a port.

  • Container Visits: Returns the latest detailed information for specified containers.  Up to 10 containers can be searched at any one time.

  • Container event subscriptions: This is a suite of operations which allows container events to be sent to any end point or email you specify.

  • Export Pre-Advice: Submit export container details to Ports of Auckland, Port of Tauranga and Timaru Container Terminal.

  • Shipping Line Endpoints: PortConnect offers the following end points exclusively for the use of shipping lines.

    • Bookings

    • Storage Pre-Advice

Signing Up

In order to use the PortConnect API, you need to sign up to our Microsoft APIM based developer portal, which is located at https://developer.portconnect.io .  

Once signed up, you will be able to subscribe to either the Full Access or Trial product variations for the API, via the "Products" menu.  Both products contain the same API end points, and both products require you to accept the PortConnect API terms and conditions of use.

Once you sign up for the Trial, the free 3-month trial will commence.

If you sign-up for the Full Access, charges will apply. Please refer to our Pricing page.

Once the subscription is confirmed, an API key will be generated.  You can see your API key from the Profile menu. 

All calls to the PortConnect API must include either the primary or secondary key in the header Ocp-Apim-Subscription-Key.  You can regenerate your subscription key any time you choose.

Rate Limit

Trial Subscription

Limited to 120 calls to any endpoint within 60 seconds and 100 API calls to any end point within a 24 hour period.

Full Access Subscription

Limited to 240 calls to any endpoint within 60 seconds. Overall cap of 10,000 calls in a 24 hour period.

Pricing

Please refer to our Pricing page.

A free trial subscription is available for 3-months. To register interest in a trial or for a full access subscription, please contact User Support info@portconnect.co.nz

Terms & Conditions
Users must be subscribed to Track & Trace for all API services.

Developer Portal

The Developer Portal is a useful tool that provides documentation for end points and auto-generated definitions for API object models. It also includes a test function that allows you to test API calls against our live data.

The PortConnect API endpoint to use from your client application is https://api.portconnect.io.  The developer portal can generate sample code in a number of different programming languages:

 

 

 

Feel free to use other API tools such as Postman.  See the resources section below for some Postman tests you can use.

 

JSON format

The PortConnect API uses JSON language and only supports JSON with double quotes (“).

 

 

© PortConnect 2023