API 2.1 - Doin’ It Right - Sandbox & Error Management

Many features have been deployed since version 2.0. Sandbox, Error management, Token management. 🚀 Click here to access the complete v2.1 changelog.

Sandbox

You can now have a testing environment, called "sandbox", on which you can test your code without actually interacting with our data. Meaning:

• A Smart user can test the API without consuming credits
• A Connect user can test posting loads or offers without them actually being posted, notifying real users

You will receive mocked prices in return, mocked loads or offers, etc. This will allow you to properly configure the API in your systems before connecting to our production APIs and thus actually consuming credits or posting real loads and notifying all carriers 😉

With a Sandbox token, you can use the Sandbox routes with the addition of ".sandbox" in the request URL which will therefore become, for example for an Air benchmark:

• Prod: https://api.upply.com/v1/smart/benchmark/air
• Sandbox: https://api.sandbox.upply.com/v1/smart/benchmark/air

The official API documentation on the different environments is available here. 😊

• https://developers.upply.com/docs/environments

Error Management

API 2.0 included very simple error management, you just knew if there was a problem or not, but could not know what this problem was. It was a choice in order to release API 2.0 earlier.

Since this release, we have therefore added improved error management which now allows you to have direct feedback from the API indicating where the error is and how to adapt their code to call us correctly and interact with us without any issue. 🤝

API Keys (tokens): consumption limits and temporality

When creating an API key, you can now request a temporality limit that will deactivate the key once this date has passed. Also, you can request that the Smart key be limited in credits, the user can therefore use the key until it spends the credits allocated on this key.

The use cases are often those of a large company that will have several teams, several consumptions, POCs with a temporality, etc.

What’s next?

We are actively working on the next API topics that will arrive in the coming months:

• API Connect:
  • Get existing live batches
  • Post a batch
• API UFIs:
  • Be able to get the list of UFIs
  • Retrieve past data from a UFI
  • Retrieve future data (forecasts) from a UFI

Feedback

Any questions? Feel free to address them to your sales contact or our customer care. 🙂

All feedback is valuable 💖 So, please provide all feedback and we will investigate, respond, and improve! 🚀