The API Keys section in the Sandbox environment provides the necessary credentials to authenticate integration requests between Bakuun and your system. These keys are grouped by function and allow access to:
- Mapping configurations
- ARI (Availability, Rates, Inventory) data
- Booking retrieval and management
You can reveal, copy, or regenerate each key depending on your technical setup and integration needs.
Each key also displays its last used date and creation date for easy monitoring and security tracking.
Let’s now break down each key type and its purpose.
API Keys → Mapping Keys
Used to authenticate API requests that retrieve your property’s mapping configuration.
Table Reference - API Keys → Mapping Keys
| Field | Description |
| Identifies the purpose of the key → either Read (for pulling mapping data from Bakuun) or Post (for pushing mapping data into Bakuun). |
| The actual API key used for authentication. For security, keys are partially masked by default. |
| Shows the most recent timestamp when the key was used. If unused, a dash (–) is shown. |
| The date the key was first generated. |
| Clicking this regenerates the key, invalidating the old one. Use this if a key needs to be rotated. |
| Clicking this will unmask and show the full API key. Make sure to handle keys securely when revealed. |
Note: These keys are used exclusively for mapping configuration. Ensure they are only shared with authorized technical users.
API Keys → Search Keys → Pull API
This section displays the Search Key, which is required to authenticate API requests made by the Buyer to perform availability and rate searches across the supplier’s inventory.
Table Reference - API Keys → Search Keys → Pull API
| Field | Description |
| The label assigned to the key. |
| The actual encrypted API key. This is used by the Buyer to send valid search requests. It can be revealed or regenerated if needed. |
| Shows the most recent timestamp when the key was used. If unused, a dash (–) is shown. |
| Shows the date the key was generated. Helps track initial setup or refresh timelines. |
| Clicking this regenerates the key, invalidating the old one. Use this if a key needs to be rotated. |
| Clicking this will unmask and show the full API key. Make sure to handle keys securely when revealed. |
API Keys → ARI Keys → Push API
These keys are used to authenticate API calls related to Availability, Rates, and Inventory (ARI). They allow your system to securely push or pull ARI updates from Bakuun.
Table Reference - API Keys → ARI Keys
| Field | Description |
| Identifies the type of ARI key: Read (pull ARI data) or Post (send ARI updates). |
| The authentication string used in API requests. Keys are hidden by default for security. |
| Shows when the key was most recently used. Displays a dash (–) if never triggered. |
| The date the key was first generated. |
| Clicking this regenerates the key, invalidating the old one. Use this if a key needs to be rotated. |
| Clicking this will unmask and show the full API key. Make sure to handle keys securely when revealed. |
Note: Use ARI keys for any automation involving rate, availability, and inventory updates between your system and Bakuun.
API Keys → Booking Keys
These keys are used to authenticate API calls related to booking data. They allow your system to fetch or send booking-related information such as reservations, modifications, or cancellations.
Table Reference - API Keys → Booking Keys
| Field | Description |
| Indicates the key type: Read (to retrieve booking data) or Post (to send booking actions like cancellations or modifications). |
| The secure authentication string used in booking-related API requests. Keys are hidden by default. |
| Displays the last date/time the key was used. A dash (–) means it hasn’t been used yet. |
| The date the key was first generated. |
| Clicking this regenerates the key, invalidating the old one. Use this if a key needs to be rotated. |
| Clicking this will unmask and show the full API key. Make sure to handle keys securely when revealed. |
Note: These keys are essential for syncing your system’s booking records with Bakuun’s platform in real time.