Skip to main content
Affiliate API
Updated over 6 months ago

How to receive API keys

Two types of API integrations are available for our partners: Affiliate and B2B. Contact your account manager to find out the details and receive technical specifications and API keys. In your request, you must indicate the website address where the product will be placed and describe its parameters: the target customer group, the order of booking, and other information.

You can only receive a Production key after completing integration using the test key and undergoing certification.

For security purposes, API keys can’t be forwarded by email. The API tab will appear in your Personal Account when the account manager informs you about the successful launch of the sandbox key (test key).

To locate your API keys:

  • Select the name of the company in the upper right corner.

  • Click Settings in the open

  • Select Contract settings and choose the API section. There you will see all keys issued for your contract. You can copy them directly.

To receive the Production key, send a request to [email protected]. Include the address of the website with completed integration or provide access to a test environment. You will then receive a link to undergo certification.

Information about API keys

The method of API authorization is HTTP Basic Authentication (Basic Auth). The information from queries is always transmitted in the JSON format.

Each key indicated in the “Contract Settings” tab contains these parameters:

  • Key ID — login

  • API key token — password

  • Endpoint URL — addresses for queries of the main methods

  • Limit on queries — each key has limitations on the number of queries

You can increase the query limit, but only if there is reasonable necessity and the number of completed bookings.

A key can be:

  • a test key — sandbox

  • a production key

The test API key can only be used to book the test hotel (test_hotel, test_hotel_do_not_book). All test bookings must be cancelled manually.

How to cancel a test booking

To cancel a test booking, follow the cancellation link in the Confirmation email, or you can also do this in your “Personal Account” on ZenHotels. If you are unable to cancel the booking, contact your account manager or email our customer support center at [email protected] and indicate the order number.

Do not use any of the following as the client’s contact details:

  • An email address connected to RateHawk or an affiliate office

  • Incorrect information, for example, a selection of letters instead of a name or a phone number, such as 11111111111.

The system will mark such bookings as fraudulent, and your email address will end up on the blacklist.

Where to direct your questions if there are problems with the API

If you have any technical questions about the API, send a request to [email protected] and attach:

  • An example query

  • A link to the specific method that’s used

  • ID of the key that’s used (if required or if you are using more than one key)

  • A detailed description of the error

Indicate the contract number, and/or the company name in the subject line. The format of logs is JSON.

When communicating with the support team, please save the entire history of correspondence and all its participants and do not change the subject line. To do this, always use the “Reply all” button.

The address [email protected] is only intended for technical support; your account manager will help resolve any questions concerning the terms of work.

Did this answer your question?