1-How do I manually insert the idOI of an elloha account in APIDAE?
TheidOI(see here how to identify it) is the id of an owner's elloha account (host or business, restaurant, transport, etc.). It is used to reconcile (or match) the owner's elloha account ("hot"/transactional data) with their APIDAE record ("cold"/descriptive data).
The destination's web service provider can use it to display an availability and/or booking widget on the APIDAE record on the destination's website, or to call up the elloha availability API (custom booking modules).
If the elloha account does not come from an APIDAE SIT file (account created directly in signup/APIDAE file not transformed from the elloha TDR), or if you do not have the SIT connector, you can manually edit the metadata in APIDAE to fill in the idOI as detailed in this article from the APIDAE knowledge base:
Apidae metadata editor
Here is an example of a metadata entry
Creation date 15/02/2021 Modification date 15/02/2021 Data {"id": "7d2eb2a8-181b-42f7-9379-8afbeebf7e55"}"id" => idOI of the elloha account
When you display the elloha account in your Network Header, it appears in the browser URL:
The metadata editor is also useful in the particular case where the SIT record corresponds to only one of the offers of an ellohac account, as explained here:
2-How do I automate the sending of the idOI in the APIDAE metadata?
If you have asked for the APIDAE SIT connector to be set up, elloha can send the booking identifiers (idOIs) of elloha accounts open for marketing and managed in the elloha TDR marketplace application back to theAPIDAE Metadata API via Automated Export.
The APIDAE metadata can also contain "tags" (free criteria) agreed with the destination which determine, for example, whether the APIDAE record should display an availability widget (calendar) only, or an online booking button rather than a simple availability widget.
For more information on the APIDAE Metadata API: http: //dev.apidae-tourisme.com/fr/documentation-technique/v2/metadonnees/consultation
Important note: Not all APIDAE records for a destination equipped with elloha have their elloha metadata filled in.
-A Write Export project (with metadata) must first be opened on the APIDAE side and set up to automatically send the idOI from elloha to APIDAE (EDIT 11/2022: subject to invoicing).
-Only elloha accounts from a transformed APIDAE record can have an "idOI" inserted in the APIDAE Metadata JSON. In other words: if the account is created in signup directly by the pro or the trsnformed record was created directly in elloha, it is not possible to make the link with the APIDAE record. The metadata must be entered manually (see the first point of this article).
3-Use of the APIDAE metadata via the elloha availability API
The front-end generation of booking links or HTML code for the elloha availability/booking widget can be done dynamically by the web service provider on the basis of :
theIdBookingEngine of the booking engine. Identifier for the elloha API sent by the elloha marketplace deployment referent ([email protected]) to the APIDAE member.
theId transmitted in the APIDAEMetadata API (IdProduct or idOI, it's the same id) for each elloha account opened for sale from an APIDAE SIT file.
It is possible to target a specific product via the detailed availability transaction (step 2) of the elloha availability API for Accommodations.
Refer to the documentation for the elloha detailed availability API for activities in order to build an availability query using the idProduct (idOI) taught in the metadata of the APIDAE file
4-Integration of elloha booking widgets
An elloha account allows its owner to generate various booking widgets to be integrated into their website: booking engine, booking button, availability calendar, tourist guide, etc. These custom widgets can also be deployed on the destination's website.
As with calling theelloha availability API, the front-end generation of the code for the availability widget or other elloha widget can be based on the APIDAE Metadata API id (IdProduct) and the booking engine publication id (IdBookingEngine) of the elloha TDR.
If you directly integrate the widget code generated from a service provider's elloha account, the sale made via the module will be attached to the direct sales of the elloha account and not to the booking-engine sales of the destination's elloha Network Head.
Here is an example of IdBookingEngine from the publication project: 333fffe4-7ab2-4043-9294-7f38ef8007b9
This is the identifier found in the URL of the general BE as transmitted by the elloha marketplace deployment referent ([email protected]).
For example: https: //reservation.elloha.com/Search/Index/333fffe4-7ab2-4043-9294-7f38ef8007b9
You need to use this IdBookingEngine to replace the one present in the widget codes generated in elloha (availability widget, BE widget, booking buttons widget, etc.) in the URL "https://reservation.elloha.com/...".
Example below with the "My calendar" widget created in the Modules section of a service provider's elloha account. The principle is the same for all types of widget.
Example of an elloha proprietary dispo calendar widget:
<div id="ConstellationCalendarContainerbd158200-2db4-4452-b75e-c8d2cbf4075b" style="width:100%; text-align:center; "title="Chez Sebastien" data-id-projet='bd1582002db44452b75ec8d2cbf4075b'>Loading in progress...</div><script type="text/javascript" src="https://reservation.elloha.com/Scripts/widget-loader.min.js?v=39"></script><script type="text/javascript">var constellationWidgetUrlbd1582002db44452b75ec8d2cbf4075b, constellationTypeModulebd1582002db44452b75ec8d2cbf4075b; constellationWidgetUrlbd1582002db44452b75ec8d2cbf4075b = 'https://reservation.elloha.com/Widget/BookingCalendar/bd158200-2db4-4452-b75e-c8d2cbf4075b?idoi=460550bb-f298-4b90-9f41-743eef361c16'; constellationTypeModulebd1582002db44452b75ec8d2cbf4075b = 2; constellationBookingCalendarLoad('ConstellationCalendarContainerbd158200-2db4-4452-b75e-c8d2cbf4075b'); constellationWidgetAddEvent(window, "resize", function () { constellationWidgetSetAppearance('ConstellationCalendarContainerbd158200-2db4-4452-b75e-c8d2cbf4075b'); });</script>
You need to replace the IdBookingEngine in the URL: 'https://reservation.elloha.com/Widget/BookingCalendar/bd158200-2db4-4452-b75e-c8d2cbf4075b?idoi=460550bb-f298-4b90-9f41-743eef361c16';
bd158200-2db4-4452-b75e-c8d2cbf4075b (IdBookingEngine of the module for this elloha account) with
333fffe4-7ab2-4043-9294-7f38ef8007b9 (general IdBookingEngine of the elloha Network Head).
This gives you an availability calendar widget that can be integrated into the APIDAE description sheet, which is then displayed on the destination's website:
Example of an elloha Network Head availability calendar widget
<div id="ConstellationCalendarContainerbd158200-2db4-4452-b75e-c8d2cbf4075b" style="width:100%; text-align:centre; "title="Chez Sebastien" data-id-projet='bd1582002db44452b75ec8d2cbf4075b'>Loading in progress...</div><script type="text/javascript" src="https://reservation.elloha.com/Scripts/widget-loader.min.js?v=39"></script><script type="text/javascript">var constellationWidgetUrlbd1582002db44452b75ec8d2cbf4075b, constellationTypeModulebd1582002db44452b75ec8d2cbf4075b; constellationWidgetUrlbd1582002db44452b75ec8d2cbf4075b = 'https://reservation.elloha.com/Widget/BookingCalendar/333fffe4-7ab2-4043-9294-7f38ef8007b9?idoi=460550bb-f298-4b90-9f41-743eef361c16'; constellationTypeModulebd1582002db44452b75ec8d2cbf4075b = 2; constellationBookingCalendarLoad('ConstellationCalendarContainerbd158200-2db4-4452-b75e-c8d2cbf4075b'); constellationWidgetAddEvent(window, "resize", function () { constellationWidgetSetAppearance('ConstellationCalendarContainerbd158200-2db4-4452-b75e-c8d2cbf4075b'); });</script>
You can re-use this elloha widget "type" code specific to the general BE of the destination and integrate it on the other detail pages of the website by modifying the idOI (IdProduct) in the widget code :
since you can have this "id" in the JSON of the APIDAE Metadata API.
Please note that the various ways of integrating elloha reservations on a destination website are presented here:
See also for widgets and BE URL constructions:
5-Use of elloha-APIDAE metadata tags
The "tags" in the metadata are specific to each APIDAE member, who can request their creation from elloha. The wording is free and a record may be assigned several "tags" in the metadata.
Once created, the tags can be assigned to the elloha accounts of the destination and then go back up into the APIDAE metadata in order to determine a specific behaviour of the APIDAE record on the front end in terms of transactional functionalities. The administration of these transactional criteria is then carried out in the elloha Network Head application rather than in the APIDAE SIT.
The typical example is the combination of "dispo" and "dispo-resa" tags. It is then up to the web service provider to make the front-end appearance of an availability widget for the product conditional on the presence of the "available" tag in the metadata, or else a reservation widget enabling the complete sales process for those tagged "available".
The destination may, for example, wish to filter its catalogue to allow the sale of only those products tagged "Subscription-2021".