Changelog
Connect with Sales
Back to All
added

API 2.3 - Around The World - Connect Post Loads

12 months ago by Florent

Many features have been deployed since version 2.2. Post Loads, Get Load Information as a Shipper, Rate Limits and Pagination. 🚀 Click here to access the complete v2.3 changelog.

📦 Connect: API POST Loads

Users with Shipper access can now post loads via API on our platform!

You got it right, this API is the keystone of our scalability for Connect: if we are directly interfaced in our clients' information systems (TMS, data warehouse, etc.), several dozens/hundreds of loads per day will flow into Connect!

Knowing this, the tech and product teams have meticulously studied every detail of this API to test it thoroughly, every corner and business rule is followed with attention to ensure an SLA as close as possible to 100%.

And of course, a sandbox exists, so that our users don't post test loads in production!

💡 All sandbox-related information is available on the public documentation website → https://developers.upply.com/reference/sandbox

📦 Connect: API Get Load Information (Shipper version)

This Connect API allows to retrieve the information of a given load with an identifier previously obtained (using the previous API, for example). This API was usable since 2.2 only by a company with Carrier access. It is now usable by a company with Shipper access. It will have access to more information than the Carrier:

  • contact information in pickup and delivery
  • The orderReference of the concerned load

💡 There is no sandbox for this API at the moment (either Carrier or Shipper). Since this API does not interact with our live data (read-only), we preferred to build the sandbox later on this API to release the production version earlier. This sandbox will come out in future releases.

⚙️ Pagination Structure

💡 Pagination in an API is like a table of contents for online data. Imagine you have a long list of information, like a product catalog. Instead of loading and showing everything at once, which can be slow and overwhelming, pagination splits this list into several smaller "pages". Each time you request a part of the data, you get a specific page, a bit like turning the pages of a book to find what you are looking for. This makes searching and loading data faster and more manageable.

  • The listed loads are integrated into a field named data
  • An additional field named pagination exists beside data
  • A link to the previous and next pages is provided when they exist in the pagination field.
  • All links are objects with a href field
  • The pagination must contain the number of elements of the list
  • The limit for nextPage and previousPage is always the user's request limit or the default limit
  • The offset of nextPage is the current offset plus the limit
  • The offset of previousPage is the current offset minus the limit

🌐 Public documentation for pagination → https://developers.upply.com/reference/pagination

⚙️ Rate Limit Rules

🥗 The rate limit in an API is like a quota in an all-you-can-eat buffet. Imagine the restaurant limits how many times you can serve yourself in an hour to ensure everyone has enough to eat and the kitchen can keep up. In the same way, an API sets a maximum number of requests you can make within a certain time to avoid overloading and ensure a stable and efficient service for all users. If you reach this quota, you need to wait a bit before you can make new requests.

  • For our GET APIs (information retrieval), we currently limit to 1 call every 5 seconds per API key
    • This will evolve with client feedback
  • For our other APIs, we have no imposed limitation

💡 Public documentation for rate limit → https://developers.upply.com/reference/rate-limit

⚙️ Connect API Renaming

A quick renaming was done to be more user-friendly in our endpoints:

  • List Load → List Loads
  • Get Load as Carrier → Get Load Information

What's Next?

In a few words:

  • Connect API:
    • Sandbox API List Loads & Get Load Information
    • Update a load's status
    • Retrieve a load's status
  • Smart API - UFIs:
    • Be able to obtain the list of UFIs
    • Retrieve past data of a UFI
    • Retrieve future data (forecasts) of a UFI