Découvrez l’essentiel des informations nécessaires avant de développer votre site avec des données APIDAE.
Quel type de projet pour commencer ?
Projet de test
Une fois enregistré en tant que membre de la communauté des développeurs, vous pouvez créer un projet test via le bouton accessible Créer un projet de test sur la page Diffuser > Mes projets > Projets.
Vous pouvez aussi accéder à l’ensemble des outils réservés aux développeurs dans le menu Diffuser > Outils développeur, en particulier les outils de sérialisation qui vous donneront un aperçu du format de données Apidae.
Complètement fonctionnel, mais limité sur le nombre d’objets touristiques, ce projet vous permet de manipuler à la fois les API et les exports et d’apprécier le fonctionnement de la plate-forme Apidae.
Projet de diffusion
La création du projet est à réaliser par votre client.
Une fois créé, il vous invitera à participer à son projet, ce qui vous permettra en fonction de la configuration de collaboration effectuée par votre client, de configurer les aspects techniques et le contenu (filtres et sélections) de votre projet.
Une fois invité, le projet apparaît dans la liste Diffuser > Mes projets > Projets.
Projet d’API en écriture
La création du projet est à réaliser par votre client.
Une fois créé, il vous invitera à participer à son projet, ce qui vous permettra, en fonction de la configuration de collaboration effectuée par votre client, de créer, modifier ou demandeer la suppression des objets touristiques dont il est propriétaire au travers d’API dédiées à cet effet.
Une fois invité, le projet apparaît dans la liste Diffuser > Mes projets > Projets.
Projet d’écriture multi-membres
Ce type de projet est un extension du projet d’API en écriture. Il répond à la problématique de pouvoir agir sur des objets appartenant à différents membres à partir d’un seul projet.
La création du projet est à réaliser de votre côté.
Une fois créé, vos différents clients pourront venir s’abonner à ce projet, vous donnant ainsi l’autorisation de modifier leurs objets de la même manière qu’avec un projet d’API en écriture.
Vos clients peuvent s’abonner à votre projet en accédant aux projets présents dans la liste Diffuser > Mes projets > S’abonner.
Il apparaîtra alors, pour eux comme ça l’était déjà pour vous, dans la liste Diffuser > Mes projets > Projets.
Projet de métadonnées
L’utilisation de métadonnées est une façon d’enrichir la plate-forme Apidae avec des informations qui n’y sont pas nativement gérées mais ayant vocation à être exploitées par tout ou partie du réseau Apidae. La métadonnée n’est pas et ne doit pas être l’information proprement dite mais un identifiant ou une série d’identifiants permettant d’établir un lien vers cette information.
La création d’un projet de métadonnées passe en premier lieu par une demande à effectuer auprès du réseau (info@apidae-tourisme.com). Cette demande doit comporter les informations suivantes :
- Une description du service apporté par votre métadonnées. Cette description doit permettre d’identifier la nature des informations que votre métadonnée manipule (par exemple : la métadonnée sert-elle à interagir avec une centrale de réservation, afficher des séances de cinéma, etc.), le niveau de visibilité (par exemple : la métadonnée va-t-elle enrichir des objets rattachés à une ville, un département ou une région particulière ? Avez-vous déjà identifié une liste de partenaires susceptibles d’exploiter cette métadonnée ?)
- Le nom que vous souhaitez utiliser pour définir/exploiter votre métadonnée. En effet, un même objet peut comporter un ensemble de métadonnées issues de partenaires différents, ce nom servira à identifier votre métadonnée, tant pour sa mise à jour que pour son exploitation.
- Une présentation du format envisagé
- Une documentation d’exploitation sur la manière dont votre métadonnée sera exploitée (par exemple : au travers d’un widget, un webservice, une redirection vers une URL, etc.)
Suite à la validation de votre demande, un nouveau point d’entrée associé à votre métadonnée (nœud) est créé dans Apidae, sur la base du nom communiqué dans votre demande. Vous pouvez alors créer et configurer votre projet d’alimentation de vos métadonnées puis utiliser l’API de gestion associée pour intégrer vos données dans la plate-forme Apidae.
Reprise d’existant
Vous reprenez un projet Apidae développé par un tiers. Plusieurs options s’offrent à votre client pour mener à bien la migration.
Vous ajouter comme collaborateur du projet existant, en supprimant ou non la collaboration de l’ancien prestataire. Vous transférer les sélections gérées par son ancien prestataire ou créer une copie du projet existant (dans ce cas, il faut prévoir une mise en correspondance des identifiants de sélection, ces identifiants étant propres au projet).
Migration de technologie de diffusion
Le volume d’objets touristiques de vos projets a augmenté, vos besoins de retraitement de l’information Apidae sont trop important pour continuer à utiliser les API ? Il est peut-être nécessaire de changer de technologie. Les exports permettent de traiter des volumes plus importants avec son mode différentiel et facilite par son mode déconnecté le retraitement des informations.
Des guides sont disponibles pour mener à bien cette migration.
> Configuration d’un projet d’export
> Documentation des exports
Comment choisir entre API et Export ?
Les API et les exports offrent des fonctionnalités et des simplicités d’usage différentes. Il est important de choisir de manière judicieuse la solution retenue, en la confrontant aux besoins présents et futurs de vos clients.
Si cela s’avère nécessaire, les formats de données des API et export sont proches et peuvent vous permettre de faire évoluer vos développements si le besoin s’en fait sentir.
> Comparaison des API et exports
Opter pour le temps réel
Pour les projets exploitant les API, Apidae a mis en place un nouveau fonctionnement « Temps Réel » permettant :
- D’être alerté tout de suite de la modification d’un objet touristique faisant partie des sélections du projet,
- De mieux solliciter nos APIs pour des appels pertinents.