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.
API Overview
API platform provides a variety of APIs, enabling users to access and subscribe to terminal data in key operational areas:
- Vessel Service
- Inventory Service
- Orders Service
- Event Service
- Road Service and many more.
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”
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
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.
If you have any questions, email [email protected].
You are now leaving Port Houston's website
Port Houston provides links to web sites of other organizations in order to provide visitors with certain information. A link does not constitute an endorsement of content, viewpoint, policies, products or services of that web site. Once you link to another web site not maintained by Port Houston, you are subject to the terms and conditions of that web site, including but not limited to its privacy policy.
Click the link above to continue or CANCEL