Request Format & Responses

Review how your request should be formatted and the ideal response structure.

Base URLs

• SANDBOX BASE URL: https://delivery-staging.apiideraos.com/api/v2/token

• PRODUCTION BASE URL: https://delivery.apiideraos.com/api/v2/token

Request Header

Shiip uses Bearer Authentication to securely authenticate API requests. To authorize your requests, you need to include an Authorization header in every API call. The header should follow this format:

Authorization: Bearer <API_KEY>

Here, <API_KEY> is your unique secret key, which is required for each request to validate your access. This token must be kept secure, as it grants access to your account's API functionality. Without the correct Bearer token in the header, requests to the API will be denied.

Response Sample

Our JSON responses adhere to a consistent format, which includes the following fields:

• status: Indicates the overall success(true) or failure(false) of the request.

• message: Provides a descriptive message or error details relevant to the request.

• data: Contains the main content or payload of the response, which varies based on the API endpoint.

• status_code: Represents the HTTP status code associated with the response, reflecting the outcome of the request.

This structured format ensures that responses are uniform and easily interpretable, facilitating effective error handling and data processing.