uShip API Developers Agreement
The uShip API enables developers to programmatically complete many functions on the uShip platform. For example, you can receive listings for specific categories or price estimates from the uShip platform. To use the API you need a token to identify yourself to the uShip platform. This token will need to be passed with every request you make to the uShip platform.
As part of this agreement, we have laid out guidelines for your application that supports our API. Please note that uShip can suspend, restrict, or terminate a user if the API is abused. The guidelines are listed below; they are specific to the performance criteria of each application. They affect key operating functions: error handling, request frequencies, and simultaneous requests.
Currently these guidelines are for all requests, but in the future specific requests may have different guidelines. If this agreement changes, we will notify all developers.
- Infrastructure Errors:
These errors have to do with the uShip site, web servers, or database servers. The symptoms of this type of error would be no response, unable to connect to uShip, or a database error is returned. If an infrastructure error occurs, please retry 3 times. If the error is still present, test the connectivity or email us at firstname.lastname@example.org.
- Application- Level Errors:
These errors have to do with the uShip API business-level logic. In this case the API returns an error object for you to examine. If an Application-Level error occurs, please verify that the input arguments and requests are valid before retrying. If you still receive an error, please report the problem as a bug to email@example.com.
- uShip has the right to restrict an application’s request frequency for any request. We will restrict request frequency when uShip feels that the number of requests by your application is negatively affecting the uShip site.
- Any multi-threaded application must have the ability to increase or decrease number of threads per call.
- New applications must use the newest version in production presented with this agreement.
- A token is assigned to one company or entity.
- A token should not be shared by multiple companies. If a developer is programming on behalf of multiple companies they will use separate tokens for each company.