Data Integration

Efficiency is
Essential at
our Gates

Port Houston offers access to terminal data through multiple APIs. Many of these API’s allow users to subscribe to real-time-updates.

Request API Access

API Overview

API platform provides a variety of APIs, enabling users to access and subscribe to terminal data in key operational areas:

Getting Started

All the Rest API’s require an authentication header with a valid access token to receive data. Upon registration, Port Houston will issue a Client ID and Client Secret that will be used to generate the token. Click here to register.

Generate an Access Token Request

curl -v –location -X POST \
https://auth-v1.america.naviscloudops.com/auth/realms/phaprod/protocol/openid-connect/token \
-H “Content-Type: application/x-www-form-urlencoded” \
–data-urlencode “client_id=YOUR_CLIENT_ID” \
–data-urlencode “client_secret=YOUR_CLIENT_SECRET” \
–data-urlencode “grant_type=client_credentials”

Download API Documentation

API Sample Codes

GetVesselSchedule
GetVesselSchedule API is responsible for returning vessel/voyage details for vessels calling the terminal within a specified date range. This API will return general details regarding the vessel visit and any associated cutoff information.

Request Details
From Date (eta YYYY-MM-DD),
To Date (etd YYYY-MM-DD)

Sample API URL
Click here to view sample code

GetContainerAvailability
GetAvailableContainers API is responsible for checking the availability of import containers to be picked up from the terminal. This API checks for any Road Impediments that may prevent the container from out-gating, and returns them to the user along with relevant details about the unit.

Request Details
Container Number (unitId)

Sample API URL
Click here to view sample code

 

GetAvailableContainersByBOL
GetAvailableContainersByBOL API is responsible for checking the availability of import containers to be picked up from the terminal. This API finds containers associated to a bill of lading and determines if any Road Impediments exist against the associated containers.

Request Details
Bill of Lading Number (blNbr)

Sample API URL
Click here to view sample code

 

GetEquipmentOwnership
GetEquipmentOwnership API is responsible for checking the ownership of a unit.

Request Details
Container Number (unitId)

Sample API URL
Click here to view sample code

createAppointment
The createAppointment API is used to create an initial gate appointment at the terminal. Once created, a unique PIN is assigned to the appointment, which can be used to update, cancel, or validate the appointment at the terminal gate.

Request Details
appointment date
Appointment time
Gate id
truck license nbr, trucking co id
tran type
container eqid
chassis eqid, is-owners

Sample API URL
Click here to view sample code

 

updateAppointment
The updateAppointment API is used to update a gate appointment at the terminal. To update an appointment, you will need the unique PIN number associated with the created appointment and pass this in the API.

Request Details
appointment date
Appointment time
Gate id
truck license nbr, trucking co id
tran type
container eqid
chassis eqid, is-owners
appointment-nbr

Sample API URL
Click here to view sample code

 

cancelAppointment
The cancelAppointment API is used to cancel a gate appointment at the terminal. To cancel an appointment, you will need the unique PIN number associated with the created/updated appointment and pass this in the API.

Request Details

appointment-nbr

Sample API URL
Click here to view sample code

GetBookingInquiry
GetBookingInquiry API is responsible for checking if an export booking exists. If the booking is on file in the terminal operating system, the API will return general routing details about the booking.

Request Details
Booking Number (subType = BOOK and nbr =””)

Sample API URL
Click here to view sample code

GetEquipmentHistory
GetEquipmentHistory API is responsible for returning service events that have been recorded against a container in the terminal operating system. The API will return the event ID, time stamp information regarding the event, and any other notes associated with the event.

Request Details
Container Number (appliedToNaturalKey)

Sample API URL
Click here to view sample code

GetGateTransactions
GetGateTransactions API is responsible for returning the details of Gate Transactions in the terminal operating system.

Request Details
Transaction Number (nbr)

Sample API URL
Click here to view sample code

Request API Access

Fill out the following to request API access. Once your request is approved, you will receive an email with your client credentials.

Appointment Functionality?(Required)
To Agree Terms and Conditions(Required)

If you have any questions, email [email protected].