Introduction
Welcome to the NYSHEX developer portal! Here you will find a comprehensive API reference for developers looking to integrate their applications with our platform. NYSHEX is a digital marketplace that connects buyers and sellers in the global container shipping industry. Our platform provides a transparent and efficient way to trade container freight, and our APIs make it easy for developers to build powerful applications that leverage our technology.
Whether you are a seasoned developer or just getting started with APIs, our documentation will guide you through the process of integrating with NYSHEX. Our APIs are designed to be flexible and scalable, allowing you to access the data you need in real-time. With our developer portal, you can explore our APIs, learn about our data models, and test your integrations before going live.
NYSHEX API is built using OpenAPI and REST, which are industry-standard for describing and building web services. Our API is designed to be scalable and flexible, making integration with our platform easy for developers. Our API reference provides detailed information about endpoints, request and response formats, and authentication requirements, enabling developers to quickly get started with our platform. Code samples and other resources are also available to help build reliable and robust integrations.
Thank you for choosing NYSHEX as your partner in the global container shipping industry. We look forward to working with you and helping you achieve your goals.
Authentication
Authentication is an essential part of securing access to NYSHEX APIs. We implement bearer authentication, which is an industry-standard HTTP authentication scheme that uses bearer tokens. When a user is authenticated, they are issued a bearer token, which they must include in the authorization header of their API requests.
We follow best practices for authentication to ensure the security and integrity of our APIs. This includes using secure token generation algorithms and enforcing strong password policies for user accounts. Our documentation provides detailed instructions on how to obtain and use bearer tokens, as well as information on how to refresh and revoke tokens when necessary.
Errors
This section describes common error types.
HTTP Status code summary:
| 200 – OK | Everything worked as expected |
|---|---|
| 400 – Bad Request | The request was not accepted, most likely due to a missing parameter. |
| 401 – Unauthorized | Valid API key or token was not provided. |
| 402 – Request Failed | The request failed, but the parameters were valid. |
| 403 – Forbidden | The user does not have permission to perform the request. |
| 404 – Not Found | The resource requested does not exist. |
| 409 – Conflict | The request conflicts with another request. |
| 429 – Too Many Requests | There were too many requests at one time. |
| 500s – Server Error | Server error on our end. |
Asking for help
Have questions or need support? Contact support@NYSHEX.com