Cangooroo's API is available in two formats: SOAP and REST.

Endpoint

The API endpoint is provided by the operator responsible for the Cangooroo instance your application will connect to.

In most cases, the base URL follows the pattern below:

https://ws-[clientIdentification].cangooroo.net

The specific endpoint and access credentials will be provided during the integration process.

SOAP

SOAP (Simple Object Access Protocol) is a messaging protocol used to exchange structured information between applications.

SOAP messages are transmitted in XML format and typically use HTTP as the transport protocol. As an established enterprise integration standard, SOAP provides high interoperability across different platforms and technologies.

REST

REST (Representational State Transfer) is an architectural style for building web APIs.

REST APIs use standard HTTP requests to access and manipulate resources, providing a simple, stateless communication model that is widely adopted by modern applications.

All requests and responses are exchanged in JSON format.

Making Requests

REST APIs communicate through HTTP requests sent from the client to the server.

A typical request consists of:

• An HTTP method that defines the operation to perform.
• The endpoint of the target resource.
• HTTP headers containing additional request information.
• An optional request body containing the data to be processed.

HTTP Methods

The API uses the standard HTTP methods to interact with resources.

Accept Header

The API returns responses in JSON format.

Although the Accept header is currently optional, we recommend including it in every request to ensure compatibility with future API versions.

Accept: application/json

Example:

POST https://ws-[clientIdentification].cangooroo.net/API/REST/... HTTP/1.1 
Accept: application/json

HTTP Response Codes

The API uses standard HTTP status codes to indicate the outcome of each request.

Request and Response Format

Cangooroo's REST API uses JSON as the standard format for both requests and responses.

When building a JSON request:

• String values must be enclosed in double quotes (").
• Numeric values must be sent without quotes.
• Boolean values must be represented as true or false.

JSON provides a lightweight and language-independent format that is supported by virtually every modern programming language.

GZip Compression

All API endpoints support GZip compression.

Enabling GZip compression is strongly recommended, as it reduces network traffic, improves response times, and optimizes bandwidth usage between your application and the Cangooroo servers.

Recommended Development Tools

The following tools can simplify development, testing, and troubleshooting during your integration.

Recommended tools include:

• SoapUI – Testing SOAP web services.
• Postman – Testing REST APIs.
• Fiddler – Capturing and inspecting HTTP requests and responses.

These tools are recommendations only and are not officially supported by Cangooroo.

We also recommend checking the API Release Notes regularly to stay up to date with new features, improvements, and API changes.

Authentication

Access to the API is secured through a combination of credentials and an authentication token.

Depending on the operation being performed, both may be required.

Credentials

Credentials are issued by the operator responsible for the Cangooroo instance your application connects to.

They typically consist of:

• UserName
• Password

These credentials identify and authenticate your application when accessing the API.

Token

In addition to your credentials, some operations require an authentication token generated during the Availability search.

Whenever an Availability request is performed, the response returns a unique token associated with both the credentials used and the availability results returned.

Your application must store this token and use it throughout the remaining booking flow, ensuring consistency between the availability search and the booking confirmation.

Each Availability response generates a new token, regardless of the service being searched.

Token Expiration

Tokens remain valid for 30 minutes after they are generated.

If the booking is not confirmed within this period, a new Availability request must be performed to obtain a new token.

Timezone

Unless explicitly stated in the documentation of a specific endpoint, do not include timezone information in your requests.

If a particular operation requires timezone data, the corresponding endpoint documentation will specify the expected format.