Documentation & Guides

API Changelog

04/03/2025 - Update Hotel bookings API

🏷️ Smart Actions API

  • Add new stage awaitingTdsChallenge for bookings
  • Add info on 3dsecure challenge rendering for bookings
  • Add response examples for 3dsecure challenge

27/02/2025 - Update Hotel bookings API

🏷️ Smart Actions API

  • Add details on checking a website prices without confirming availability (skipConfirmation flag)
  • Add new response example for when skipping confirmation of website prices

10/02/2025 - Update Hotel bookings API

🏷️ Smart Actions API

  • Add 2 new stages to booking objects
    • priceConfirmed: when price is confirmed in website
    • bookingConfirmed: previously called bookingConfirmation
  • Improve descriptions and added more details to endpoints usage
  • Add more request/response examples

04/02/2025 - Add Hotel bookings API documentation

🏷️ Smart Actions API

Included specifications for usage of Hotel bookings

23/01/2025 - Update Recruitment (Job boards) API

🏷️ Smart Actions API

  • Added guidance on authenticating using JWT Bearer Token as well as Basic HTTP Auth.
  • Updated body parameters used for POST /v1/recruitment/job-posts/mine/
  • Updated body parameters used for POST /v1/recruitment/job-posts/apply/
  • Corrected endpoint for GET /v1/recruitment/job-posts/application -> /v1/recruitment/job-posts/find/application/
  • Included information on GET /v2/recruitment/job-posts/find, including question categories.
  • Included information on different question types and the expected format of their corresponding answers.

22/11/2024 - Add new output for hotels (Smart Feed)

🏷️ Smart Feed API

/pull/hotels and /pull/hotel - Added new output field guests. This field reflects single occupancy configuration for a hotel. It shows if we scrape rates for 2 persons or for 1 and 2 persons.

21/11/2024 - Update info on Recruitment (Job boards)

🏷️ Smart Actions API

Renamed Recruitment (mining) tab to Recruitment (Job boards)

Update endpoints specifications (params and endpoints).

Add new sections:

  • Authentication
  • Troubleshooting
  • Known limitations
  • Development tools

24/11/2023 - More info on Recruitment (mining) API

🏷️ Smart Actions API

Mentioned and explained failed job posts

/v1/recruitment/job-posts/find - Added response example (and details) for failed scenario

24/10/2023 - Add Recruitment (mining) API documentation

🏷️ Smart Actions API

Included specifications for usage of Recruitment (mining) API

11/05/2023 - Shared Rates and Rooms

🏷️ Smart Feed API

Introduce new flags for Rooms and Rates. canBeShared for Room and isShared for Rate. /Pull/SmartFeed endpoint can optionally return those fields.

16/03/2023 - New Board Options added

🏷️ Smart Feed API

Introduce new board options: lunchIncluded, dinnerIncluded, allInclusive for a Search Result Room Rate. /Pull/SmartFeed endpoint can optionally return those fields as a part of Rate object.

03/03/2023 - bookingServiceId always present in response for /Pull/Hotel(s) endpoints

🏷️ Smart Feed API

Since this update /Pull/Hotel(s) endpoints will always return bookingServiceId field, which may be a string or null.

02/03/2023 - Client Id in /redirect end-point

🏷️ Smart Feed API

We made an update to the existing /redirect end-point in the Smart Feed API. The end-point now accepts the clientId as query parameter. This is used by Smart Feed to guarantee it will find the correct hotel using the pair hotelId (that is required by the end-point) and the clientId (that is optional but highly recommended). For more information on how to use this end-point, please refer to the new documentation page.

18/01/2023 - Hotel and hotels endpoints in Smart Feed API

🏷️ Smart Feed API

Two new API endpoints have been added to Smart Feed API. These endpoints are designed to allow users to easily retrieve hotel inventory from Smart Feed and streamline the checkout process by starting the checkout flow (job) on Smart Actions.

/Pull/Hotels endpoint allows authorized users to view a list of hotels they have access to. The list can be limited by setting the limit parameter. If the parameter is not set, the default limit is 100, and the maximum limit is 1000.

/Pull/Hotel endpoint enables users to retrieve detailed information about a single hotel by using the hotelId parameter. The hotel details returned by this endpoint include a bookingServiceId field, which can be used to initiate a job on Smart Actions.

20/10/2020 - Increased size of panToken

🏷️ Smart Actions API

WARNING

We will be issuing a new version of panToken with a bigger size on 20 Oct 2020. Please ensure this change doesn't break your integration prior to this date.

In order to enhance security around pan encryption, we have changed our encryption method and it resulted in increased size of data. It is likely you do not be affected by it as we will keep it backwards compatible for both versions of panToken, however, it is a good idea to ensure your database can store the different length of data.

panToken is going to be 299 long characters

Our vault returns a panToken which is consist of 164 long characters, but the length of data is subject to increase to 299 characters on 20 Oct 2020. This change may affect your integration in case you've optimized your DB schema to accommodate just right for this size of data. Please ensure this change doesn't affect your integration.

VersionLengthExample
v116490080f3b7e2c0c81bea640654784ce89-f3311bf802369092964c7a166472a367-ebc530d010410767d5bc9fe6fa3de068:3ad64f00b8973a54adaa38f867e3130c-e2b84703d0ea3f852ba94b568293cc73
v2299v2:v2-cb5002ed38084a1c217c2ad2d15e008113021fe74de55b5baca180d0c36fec96-12f5a40535c05decfe151ec5e475393c56ed0bb24a52db500f2303d94ace615d-7549066f09c7d2dfaa9deb8974340791:a255128c48c4045b8ffecedcb5775d599bb847e09cf3f73baac5be4d25191433-6a20d6d6dd6992fe8153359b04fe47be-5f99ad15b57c86bf465724e8beceae8d