Channel IFrame
This is the API to show an iframe for the Channex mapping screen in your application. The user will be able to create channels and map by themselves.
To generate a One-Time access token you should call the next API Method:
POST {{server}}/api/v1/auth/one_time_token
Please, don’t forget to add your Authorisation header.
You should get the following response:
{
"data": {
"token": "94feab9f-60e6-411b-d854-8f12004d8bc8"
},
"meta": {
"message": "You are successfully received one-time token! Use it for exchange to JWT"
}
}
At data.token you should receive a One-Time access token to authorise your user in Channex without providing credentials.
After the first usage, token will be removed. The token will live for 15 minutes. Once iframe loaded it will not have an expiry time.
The user will be authenticated under the same user, who requested the Access Token!
The next step is to generate the iframe to show to your user
<iframe
src="{{server}}/auth/exchange?oauth_session_key={{ONE_TIME_ACCESS_TOKEN}}&app_mo
de=headless&redirect_to=/channels&property_id={{PROPERTY_ID}}"
>
</iframe>
Where {{server}} is the address of the Channex server, {{ONE_TIME_ACCESS_TOKEN}} is the token received at the previous step, {{PROPERTY_ID}} is the ID of the Property in Channex which will be associated with the created channels.
Channex also support
group_id argument at URL, to correctly setup required Group for new channel.To allow user connect only specific channels, you can pass additional argument
channels inside URL:{{server}}/auth/exchange?oauth_session_key={{ONE_TIME_ACCESS_TOKEN}}&app_mo
de=headless&redirect_to=/channels&property_id={{PROPERTY_ID}}&channels=BDC,ABB
Available list of channels:
Code | Channel |
ABB | Airbnb |
ACO | Abode Connect |
ADO | Advertising Online |
AGO | Agoda |
BDC | Booking.com |
CTZ | CultBooking |
DDC | Despegar |
EXP | Expedia |
FER | Feratel |
GDS | OpenGDS |
GHA | Google Hotel |
GIT | Go4IT |
HBD | Hotelbeds |
HG | HyperGuest |
HIC | Hey Iceland |
HRS | HRS |
HWL | Hostelworld |
LO | LocalOTA |
MMB | MemberButton |
OC | Open Channel |
OSA | Instant Booking Page |
RC | Room Cloud |
RSR | Reserva |
TSQ | The Square |
VB | VerticalBooking |
WBK | Wubook |
WBR | Webrooms |
To simplify UI and decrease complexity for clients who will work with Channex IFrame we hide some functionality from embedded mode. But you still able to enable that functionality by pass flags as part of URL.
Allow Notifications Edit
At Channel Management dialog we have a settings to enable / disable Property Booking Notifications. Because most of PMS use they own mailing system we hide that settings at Embedded mode. But if you would like to allow client to make decision about that option, please add GET Argument
allow_notifications_edit=true into URL when embed IFrame.By pass
lng=XX you can choose a language for IFrame UI.
Right now we support next languages:- English (
en) - Portugal (
pt) - Spanish (
es)
If you are interested at new translation, please let us know by email.
By pass
read_only_availability=true you can block editing Availability at Inventory screen.The provided iframe UI is limited and only allows the user to create / edit / remove channels with the provided Property ID.
There is no access policy yet for example “Read-Only” mode. Let us know your ideas or requirements if that is needed.
This API will allow you to iframe any page from Channex, you will need to edit the redirect. All pages will generally work with property ID option.
Example to get messages page:
{{server}}/auth/exchange?oauth_session_key={{ONE_TIME_ACCESS_TOKEN}}&app_mo
de=headless&redirect_to=/messages&property_id={{PROPERTY_ID}}
Last modified 3mo ago