Premiers pas

Checklist prestataire

Découvrez les éléments essentiels à faire en tant que prestataire avant de démarrer votre travail sur un projet Apidae.

1. Créer son compte

Pour découvrir la plateforme Apidae le mieux est encore de se mettre dans la peau d’un utilisateur. Pour cela, commencez par créer vous-même votre compte sur la plate-forme Apidae en cliquant sur ce lien.
Ce premier accès vous permet de naviguer de façon plus fine dans les données, de tester l’étendue des critères, de prendre la mesure de la richesse de l’information, de commencer à voir fonctionner les widgets et le panier, d’identifier la puissance de la diffusion du réseau, de consulter l’annuaire des membres…
Vous êtes convaincu ? Vous voulez tester un projet avec les outils développeurs ? Passez à l’étape 2 et demandez la création de votre compte de membre.

2. Demander la création de son compte de membre

Seul un administrateur du réseau peut créer votre compte de membre.
Pour pouvez demander la création de votre compte en envoyant un mail à info@apidae-tourisme.com

  • les coordonnées de la société (adresse postale – tel – mail – site web)
  • le nom d’un contact commercial,
  • le n° Insee ou SIRET
  • Un descriptif court (255 caractères) pour présenter votre activité aux autres membres du réseau
  • votre nom (pour retrouver votre compte d’utilisateur déjà créé sur la plateforme)

Nous rattacherons alors votre compte utilisateur à votre compte de membre et vous serez nommé administrateur. Ce rôle d’administrateur vous donnera toute latitude pour rattacher d’autres comptes d’utilisateurs et leur donner des droits (notamment pour les comptes des autres développeurs de votre agence).
Avec ce compte de membre, vous aurez la possibilité de créer un projet test (bac à sable) pour tester les flux et comprendre les principes de fonctionnement de la plateforme en toute liberté.
C’est aussi grâce à ce compte de membre que votre client pourra partager le projet que vous aurez pour mission de développer en collaboration avec lui.

3. S’inscrire sur les mailing lists

Statut / alertes

Communication autour de la disponibilité de la plate-forme, les incidents, mises à jour.

apidae-dev-status

Annonces

Communication sur les nouveautés
et la planification des évolutions futures.

apidae-dev-announce

4. Parcourir le site d’aide aux utilisateurs

Vos clients ont la même interface que vous (voire encore plus riche). Une bonne partie des fonctionnalités seront donc utilisées en collaboration avec eux et vous avez intérêt à savoir les utiliser pour aller plus vite sur vos projets communs.
Le site d’aide utilisateurs propose plus de 300 tutos avec des descriptifs détaillés sur les diverses fonctionnalités offertes par la plateforme. Un parcours spécialement étudié pour vous regroupe les tutos utiles à votre métier : http://aide.apidae-tourisme.com/parcours-pour-les-prestataires-techniques/
Un glossaire, les définitions sur les types objets et les règles de saisie, la vie des critères qui évoluent en permanence sont autant d’informations qu’il vous faut garder à l’œil pour proposer à vos clients de rester au top de ce que la plateforme Apidae peut leur offrir.
Vous êtes maintenant paré pour commencer à répondre à un appel d’offre ou pour développer votre premier projet test.

5. Prendre en main la documentation développeur

Bien que l’interface soit très intuitive et que vous aurez vite compris comment cela fonctionne, il vous faut maintenant comprendre les flux et commencer à développer sereinement.
Le site d’aide aux développeurs et la hotline technique sont là pour développeur.
La suite de cette page vous éclairera sur comment aborder votre projet Apidae…

Les clés pour répondre
à un Appel d’Offre

Découvrez le détail des technologies ainsi que les modules essentiels à l’interfaçage avec Apidae.

From scratch

Nouveau projet, nouveau venu. Il faut tout d’abord commencer par vous créer un compte et demander à intégrer la communauté des développeurs.
Cette première étape vous permet alors d’accéder aux outils développeurs ainsi qu’à un projet de test de manière à explorer les possibilités d’exploitation de la donnée Apidae. API et/ou export sont à votre disposition et vous avez toutes les armes en main pour commencer à échanger avec votre futur client.
Nos guide sur les premiers pas avec Apidae, accompagné de la documentation technique vous permettront de découvrir les formats et les services fournis par la plate-forme Apidae et d’échanger avec votre client sur ses besoins.
> Premiers pas
> Documentation technique
> Études de cas
> Un doute sur les fonctionnalités offertes, contactez-nous

Migration de version (API, Export)

Apidae bouge et vous apporte régulièrement des nouveautés. Pour vous accompagner dans ces changements, un changelog ainsi que des guides d’accompagnement dans la prise en compte des nouveautés sont disponibles.
> Changelog
> Guide de migration v001 vers v002

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

Démarrer son projet

Découvrez comment choisir entre API ou Export et le type de projet idéal pour commencer

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

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 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 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.

Les bonnes pratiques

Découvrez la liste des bonnes pratiques à observer au cours du développement de vos projets.

1. Faites respecter la charte de diffusion de la donnée Apidae

De manière à respecter la charte de diffusion Apidae, veillez avec votre client à intégrer les éléments imposés par le réseau Apidae sur les données publiées.
> Champs de publicité de la source Apidae

2. Echappement des requêtes

Évitez-vous les mauvaises surprises en utilisant la bibliothèque Apidae PHP ou en suivant notre guide sur la mise en oeuvre de l’échappement des requêtes.
> Guide sur l’échappement des requêtes

3. Acquittement de l’intégration d’export

Améliorez le suivi disponible pour vos clients et vous-même sur la fiche projet (accès via Diffuser > Mes projets > Projets ; lien dans le tableau) en notifiant de la bonne prise en compte de la notification de fin d’export. Cette notification réalisée par votre projet d’export permet de basculer la tâche de Généré à Généré et intégré.
> Guide de mise en oeuvre de l’acquittement d’intégration d’export

4. Respect des délais de réponse pour la notification de fin d’export

Évitez des messages d’erreur lors de la notification de fin d’export en vous assurant de répondre sous les délais impartis.
> Guide de mise en oeuvre de la réponse à la notification de fin d’export

5. Identification des appels aux API et multimédias avec le UserAgent

Facilitez la vie du réseau Apidae en exploitant judicieusement le champ UserAgent lors de vos requêtes. Insérez sous la forme {prestataire} – {nom du projet} #{projetId} vos appels sur les APIs et sur les récupérations des multimédias. Cela nous permet d’investiguer et de résoudre plus rapidement les incidents. (paramètre CURLOPT_USERAGENT pour cURL)

6. Mise en place d’un cache pour l’utilisation des API et des multimédias

Assurez une expérience de navigation rapide et fiable à vos utilisateurs en mettant en place des mécanismes de cache lors de l’exploitation des API.
> Bonnes pratiques pour la mise en oeuvre de cache pour les API