1-Comment insérer manuellement l'idOI d'un compte elloha dans APIDAE ?
L'idOI (voir ici comment l'identifier) correspond à l'id du compte elloha d’un propriétaire (hébergeur ou activité, restaurant, transport...). Il permet d'assurer le rapprochement (ou correspondance) de son compte elloha ("données chaudes"/transactionnelles) avec sa fiche APIDAE (données "froides"/descriptives).
Le prestataire web de la destination peut l'utiliser pour afficher, au niveau de la fiche APIDAE sur le site web de la destination, un widget de disponibilités et/ou de réservation ou encore d’appeler l’API de disponibilités elloha (modules de réservation "custom").
Si le compte elloha n'est pas issu d'une fiche SIT APIDAE (compte créé directement en signup/fiche APIDAE non transformée depuis la TDR elloha), ou que vous ne bénéficiez pas du connecteur SIT, vous pouvez éditer manuellement la métadonnée dans APIDAE pour renseigner l’idOI comme détaillé dans cet article de la base de connaissance APIDAE :
Éditeur de métadonnées Apidae
Voilà une exemple de métadonnée renseignée
Date de création
15/02/2021
Date de modification
15/02/2021
Données
{"id":"7d2eb2a8-181b-42f7-9379-8afbeebf7e55"}
"id" => idOI du compte elloha
Quand vous affichez le compte elloha dans votre Tête de réseau il figure dans l'URL du navigateur :
L'éditeur de métadonnée est aussi utile dans le cas particulier ou la fiche SIT ne correspond qu'à une des offres d'un compte elloha comme expliqué ici.
2-Comment automatiser l'envoi de l'idOI dans la métadonnée APIDAE ?
Si vous avez demandé la mise en place du connecteur SIT APIDAE, elloha peut renvoyer via Export automatisé dans l'API Métadonnées APIDAE les identifiants de réservation (idOIs) des comptes elloha ouverts à la commercialisation et gérés dans l'application de place de marché elloha Tête de réseau (TDR).
La métadonnée APIDAE peut aussi contenir des "tags" (étiquettes en anglais, des critères libres) convenus avec la destination qui déterminent par exemple si la fiche APIDAE doit afficher un widget de disponibilités (calendrier) seulement, ou encore un bouton de réservation en ligne plutôt qu’un simple widget de disponibilité.
Pour plus d'infos sur l'API Métadonnées APIDAE : http://dev.apidae-tourisme.com/fr/documentation-technique/v2/metadonnees/consultation
Remarque importante : Toutes les fiches APIDAE d'une destination équipée de elloha n'ont pas leur métadonnée elloha renseignée.
-Un projet d'Export en écriture (avec métadonnée) doit au préalable être ouvert côté APIDAE et paramétré pour l'envoi auto de l'idOI depuis elloha vers APIDAE (EDIT 11/2022 : soumis à facturation).
-Seuls les comptes elloha issus d'une fiche APIDAE transformée peuvent avoir un "idOI" inséré dans le JSON de Métadonnées APIDAE. Autrement dit : si le compte est créé en signup directement par le pro ou que la fiche trsnformée a été créée directement dans elloha, il n'est pas possible de faire le lien avec la fiche APIDAE. La métadonnée doit être renseignée manuellement cf. premier point de cet article.
3-Utilisation de la Métadonnée APIDAE via l'API de disponibilités elloha
La génération en front de liens de réservation ou de codes HTML de widget elloha de disponibilités/réservation peut se faire de façon dynamique par le prestataire web sur la base de :
l'IdBookingEngine du moteur de réservation. Identifiant pour l'API elloha transmis par le référent de déploiement de place de marché elloha (support@elloha.com)au membre APIDAE.
l'Id transmis dans l'API Métadonnées APIDAE (IdProduct ou idOI c'est le même id) pour chaque compte elloha ouvert à la vente issu d'une fiche de SIT APIDAE.
Il est possible de cibler un produit précis via la transaction de disponibilité détaillée (étape 2) de l'API de disponibilités elloha pour les Hébergements.
Même principe pour les produits de type Activités, reportez-vous à la documentation de l'API elloha disponibilité détaillée des activités afin de construire une requête de disponibilité grâce à l'idProduct (idOI) enseigné dans la métadonnée de la fiche APIDAE
4-Intégration de widgets de réservation elloha
Un compte elloha permet à son propriétaire de générer différents widget de réservation à intégrer sur son site web : moteur de réservation, bouton de réservation, calendrier de disponibilités, guide touristique... Ces widgets personnalisés peuvent aussi être déployés sur le site web de la destination.
Comme pour appeler l'API de disponibilités elloha, la génération en front du code de widget de disponibilités ou autre widget elloha peut se faire sur la base de l'id d'API Métadonnées APIDAE (IdProduct) et de l'idPublication du moteur de réservation (IdBookingEngine) de la TDR elloha.
Si vous intégrez directement le code du widget généré depuis le compte elloha d'un prestataire, la vente réalisée via le module sera rattachée aux ventes directes du compte elloha et pas aux ventes du booking-engine de la Tête de réseau elloha de la destination.
Voilà un exemple d'IdBookingEngine du projet de publication : 333fffe4-7ab2-4043-9294-7f38ef8007b9
C'est l'identifiant qui se trouve dans l'URL du BE général telle que transmise par le référent de déploiement de place de marché elloha (support@elloha.com).
Il vous faut utiliser cet IdBookingEngine pour remplacer celui présent dans les codes des widgets générés dans elloha (widget dispo, widget BE, widget boutons de résa...) au niveau de l'URL "https://reservation.elloha.com/...".
Exemple ci-après avec le widget "Mon calendrier" créé au niveau de la section Modules du compte elloha d'un prestataire. Le principe est le même pour tous les types de widgets.
Exemple de widget calendrier de dispo propriétaire elloha :
<div id="ConstellationCalendarContainerbd158200-2db4-4452-b75e-c8d2cbf4075b" style="width:100%; text-align:center;"title="Chez Sebastien" data-id-projet='bd1582002db44452b75ec8d2cbf4075b'>Chargement en cours...</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>
Il faut remplacer l’IdBookingEngine dans l'URL : 'https://reservation.elloha.com/Widget/BookingCalendar/bd158200-2db4-4452-b75e-c8d2cbf4075b?idoi=460550bb-f298-4b90-9f41-743eef361c16';
bd158200-2db4-4452-b75e-c8d2cbf4075b (IdBookingEngine du module de ce compte elloha) par
333fffe4-7ab2-4043-9294-7f38ef8007b9 (IdBookingEngine général de la Tête de réseau elloha).
Vous obtenez ainsi un widget calendrier de disponibilités qui peut être intégré au niveau de la fiche descriptive APIDAE qui remonte sur le site web de la destination :
Exemple de widget calendrier de dispo de la Tête de réseau elloha
<div id="ConstellationCalendarContainerbd158200-2db4-4452-b75e-c8d2cbf4075b" style="width:100%; text-align:center;"title="Chez Sebastien" data-id-projet='bd1582002db44452b75ec8d2cbf4075b'>Chargement en cours...</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>
Vous pouvez réemployer ce code "type" du widget elloha propre au BE général de la destination et l'intégrer sur les autres pages de détails du site web en modifiant l'idOI (IdProduct) dans le code du widget :
puisque vous pouvez disposer de cet "id" dans le JSON de l'API Métadonnées APIDAE.
A noter que les différentes possibilités d'intégration de la réservation elloha sur un site web des destination sont présentées ici.
Voir aussi pour les widgets et les constructions d'URL BE :
5-Utilisation des tags de la métadonnée elloha-APIDAE
Les "tags" présents dans la métadonnée sont propres à chaque membre APIDAE qui peut en demander la création à elloha. Les libellés sont libres et une fiche peut se voir attribuer plusieurs "tags" dans la métadonnée.
Une fois créés, les tags peuvent être affectés aux comptes elloha de la destination et ensuite remonter dans la métadonnée APIDAE dans le but de déterminer un comportement spécifique de la fiche APIDAE en front au niveau des fonctionnalités transactionnelles. L'administration de ces critères transactionnels se fait alors dans l'application de Tête de réseau elloha plutôt que dans le SIT APIDAE.
L'exemple type est la combinaison de tags "dispo" et "dispo-resa". Il revient alors au prestataire web de conditionner l'apparition en front d'un widget de disponibilités pour le produit à la présence du tag "dispo" dans la métadonnée ou sinon d'un widget de réservation permettant le process complet de vente pour ceux qui sont tagués "dispo-resa".
La destination peut par exemple souhaiter filtrer son catalogue pour ne permettre la vente que des produits tagué "Abonnement-2021".