CruiseBe API Documentation


Use our live documentation to learn about the CruiseBe API.
To get full access to API requests and responses please contact customer support for getting API key (APP ID and APP key).

API data format

We use a simple and more concise format JSON.
To make a request with JSON, the appropriate HTTPS headers are:
Content-Type: application/json
Accept: application/json
All methods must be called using HTTPS. Arguments can be passed as GET parameters.
Each request must contain APP ID and APP key.
The API response contains JSON object, JSON array or JSON string.
Other properties are defined in the documentation for the relevant method.
API data format: long text
Long text descriptions are presented in html format.
API data format: images
All images in API are presented via absolute path.


Current API Version: v2 (November 1, 2017)

API address

Base URL:

Error Responses

If error occurs, the API response will include an appropriate HTTP status code and error description. The documentation for each relevant method provides the detailed description of error codes.
  "code": "404",
  "message": "Ship not found"

HTTP status codes

Common HTTP status codes information
200 OK Standard response for successful HTTP requests.
204 No Content The server successfully processed the request and is not returning any content
400 Bad Request The server cannot or will not process the request due to an apparent client error
401 Unauthorized Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided.
403 Forbidden The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource
404 Not Found The requested resource could not be found but may be available in the future
500 Internal Server Error A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

Explore below the list of CruiseBe API methods