- Guidelines for implementing our Truck Appointment System API: Technical Documentation (pdf).
The Truck Appointment API requires a TERMPoint account. A member of our Technical Support team will be happy to talk you through the process and help set up a test account and user(s) with the correct admin and API rights on our TERMPoint User Acceptance Testing environment. Please contact us to set up an appointment.
Truck Appointment API Authentication Approach
The authentication process involves 2 steps. The combination of these two tokens will be used to authorize API calls.
System level authentication
- Any software provider or Trucking company can register to request a key/secret from the API Store.
- Software providers have the option to use a single authentication key or require each Trucking Company using their software solution to request and obtain its own authentication key.
User level authentication
- Individual users will request access to the Truck Appointment API in APM Terminals’ appointment system (TERMPoint)
- The user access (authorization key) is generated and stored in TERMPoint. This user authentication will validate that the user is a valid TERMPoint user, associate the user to a trucking company and a terminal and validate the user’s permissions in TERMPoint
- Individual TERMPoint user permissions will be managed within TERMPoint
- TERMPoint will not pass permissions to the customer’s system.
- When a user tries to create, edit or cancel appointments, TERMPoint will check the user's permissions and either allow the action or reject it.
- If a user without permission tries to create, edit or cancel appointments via the system (API), then TERMPoint will send back an appropriate rejection message.
|APMT Truck Appointments - United States.yaml||28.04 KB|