Page Comparison

The API of Ship X platform is the primary interface for data exchange with the central system. It allows you to read and modify data.

Access to data is protected. Authorization mechanism is based on OAuth 2.0 standard. Requests are signed by using the access token of so-called Bearer Token, i.e. anyone using the correct token gains the access to specific resources through the API.

The API is a stateless interface.

HTTP response codes

HTTP response codes that may occur in the response from the server:

Errors 

If an error occurs, the API returns an error object that contains the following attributes: 

Example of response:

HTTP/1.1 404 Not Found
 
{
	"status": 404,
	"error": "resource_not_found",
	"message": "Resource you are looking for are not found",
	"details: {}
} 

For requests sent by POST or PUT method, validation errors may occur. Details related to them are under details attribute in the response:

HTTP/1.1 400 Bad Request
 
{
	"status": 400,
	"error": "validation_failed",
	"message": "Data sent by POST or PUT request are not valid. Check details for more info",
	"details: {
		"name": ["required", "too_short"],
		"post_code": ["invalid_format"]
	}
} 

 The keys of details object are names of attributes sent by POST or PUT method, for which validation errors occurred. Their value is presented in the table of error keys that are true for the sent value. Below we present a list of generic validation error keys.

Errors keys 

The following table shows error keys that can be returned by the server with the possible HTTP codes:

Keys of validation errors 

The following table shows generic keys of validation errors that can be returned under details attribute for response of validation_failed error:

Stating a value is required.