Bed-and-Breakfast.it
This guide walks through creating a channel connection between Channex and Bed-and-Breakfast.it over the API: discovering the adapter, validating the property credentials, reading the rooms and rates on both sides, building the mapping, and creating and activating the connection.
A channel connection (a channel) links rate plans of a Channex property to rooms and rates on the OTA side. Once the connection is active, Channex pushes availability, rates and restrictions to Bed-and-Breakfast.it and receives bookings back.
Every OTA has its own API and data model, so the connection settings and the mapping settings differ per channel. The flow below is shared by most channels (Booking.com, Expedia, Agoda, Open Channel–based OTAs and others); the payloads shown are the Bed-and-Breakfast.it ones. Airbnb is the exception — it requires an OAuth authorization step and is covered by a separate guide.
All endpoints require authentication with an API key, sent in the user-api-key header.
The flow at a glance
Get the adapter descriptor — what settings and mapping fields Bed-and-Breakfast.it needs.
Collect the settings from the user and run a test connection.
Get the mapping details — the rooms and rates on the Bed-and-Breakfast.it side.
Collect the Channex side — the property, its room types and rate plans.
Build the mapping structure.
Create the connection.
Activate it.
1. Get the adapter descriptor
Each channel is described by an adapter descriptor: the settings it needs (params) and the per-mapping fields it needs (rate_params).
GET /api/v1/channels/adapter?code=BedAndBreakfastItalyThe full catalog of adapters is available at GET /api/v1/channels/list.
Response (abridged):
What to read from it:
params— the connection settings to collect from the user. Each entry describes one field:title(English label),type(string,integer,boolean,select,password),position(ordering for a UI),default,options(forselectfields) and conditional displayrules.rate_params— the fields each rate plan mapping must carry (step 5), described the same way.
For Bed-and-Breakfast.it, the settings to collect from the user are property_code, property_username and property_password — the credentials of the property on Bed-and-Breakfast.it. The remaining settings have sensible defaults; see the settings reference.
2. Test the connection
Before creating anything, validate the collected settings with a test connection:
channel is the adapter code from the descriptor; settings is the object built from params.
Response:
success: true means the credentials are correct and the property is ready for connection on the Bed-and-Breakfast.it side. On failure the response is still 200 OK with success: false — check the success field, not the status code.
3. Get the mapping details
Next, fetch the rooms and rates the property exposes on the Bed-and-Breakfast.it side:
The payload is the same as for the test connection:
Response:
Every channel returns its own mapping-details shape; this one is Bed-and-Breakfast.it's.
pricing_type — the hotel's pricing model. Bed-and-Breakfast.it uses occupancy-based pricing only, so it is always OBP: each rate carries a price per occupancy option.
rooms — the rooms available for mapping. Each room carries:
id
Room ID on the Bed-and-Breakfast.it side.
title
Room title.
rates
Rates of the room.
Each rate carries:
id
Rate ID on the Bed-and-Breakfast.it side.
title
Rate title.
occupancies
Occupancy options of the rate on this room.
max_persons
Maximum number of persons.
4. Collect the Channex side
Bed-and-Breakfast.it connections are one-to-one: one connection maps exactly one Channex property to one Bed-and-Breakfast.it property. Pick the property to connect, then fetch its room types and rate plans through the options endpoints:
Enable multi_occupancy on the rate plans request: for occupancy-based rate plans it expands each occupancy option into its own entry, which is exactly the granularity Bed-and-Breakfast.it mappings need.
5. Build the mapping structure
The mapping is a list of rate_plans entries, one per (Channex rate plan occupancy → Bed-and-Breakfast.it room/rate/occupancy) pair:
rate_plan_id — the Channex rate plan UUID (from step 4).
settings — the fields declared by rate_params in the adapter descriptor:
room_type_code
Room ID on the Bed-and-Breakfast.it side.
rate_plan_code
Rate ID on the Bed-and-Breakfast.it side.
occupancy
The occupancy option of the Bed-and-Breakfast.it rate this mapping serves.
pricing_type
The hotel's pricing model — always OBP for Bed-and-Breakfast.it.
primary_occ
Whether this mapping is the primary one for its room + rate pair. The primary mapping sends availability and restrictions along with prices; non-primary mappings send prices only.
extra_adult_price
Extra adult surcharge amount. Optional.
Mark exactly one mapping of each room + rate pair as primary, and create one mapping per occupancy option you want to sell.
A full mapping for one Bed-and-Breakfast.it rate sold at occupancies 1 and 2:
6. Create the connection
The payload is wrapped in a channel key:
channel
The adapter code from the descriptor.
group_id
UUID of the group the connection belongs to. Required.
title
Connection title. Optional — generated from the channel and property names when omitted.
properties
UUIDs of the connected properties. One property for Bed-and-Breakfast.it.
settings
The connection settings built from params — the same object the test connection validated.
rate_plans
The mapping structure from step 5. Optional — mappings can also be added later by updating the connection.
The response is 201 Created with the channel connection resource (abridged):
Note that the connection starts disabled: is_active in the create payload has no effect — a new connection is always created with is_active: false. Activation is a separate, explicit step.
7. Activate the connection
No payload. Activation requires the connection to have at least one property and at least one rate plan mapping; activating starts the synchronization — Channex pushes the full current availability, rates and restrictions to Bed-and-Breakfast.it and begins receiving bookings.
The counterpart is POST /api/v1/channels/{channel_id}/deactivate, which stops the synchronization but keeps the connection and its mappings.
Updating a connection
The payload has the same shape as for create (wrapped in channel). Two rules matter:
channelcannot be changed — a different adapter code is rejected.rate_plans, when present, replaces the whole mapping set. A stored mapping missing from the list is removed, and a mapping sent withsettings: nullis removed as well. Omitrate_plansentirely to keep the stored mappings.
Deleting a connection
An active connection must be deactivated first. Deleting removes the connection and all its mappings; bookings received through it are kept.
Actions
The Bed-and-Breakfast.it adapter declares no connection actions — actions is empty on the descriptor and on every Bed-and-Breakfast.it connection.
Bed-and-Breakfast.it settings reference
The full set of connection settings for Bed-and-Breakfast.it:
property_code
The Bed-and-Breakfast.it property code. Required.
property_username
The Bed-and-Breakfast.it property username. Required.
property_password
The Bed-and-Breakfast.it property password. Required.
min_stay_type
How the minimum stay restriction is applied: Arrival (counted from the arrival date) or Through (applied to every stayed-through date). Default Arrival.
email
The email address the notifications go to.
send_email_notifications
When true, Channex sends a notification about each booking.
Last updated