Les API d’écriture permettent de créer, modifier et supprimer des fiches Apidae via l’appel à un service REST. Pour faciliter son utilisation, l’API repose sur le même format d’objet JSON que les flux de diffusion API et Exports. L’idée étant de pouvoir réutiliser au maximum les informations renvoyées par ces deux outils pour modifier les informations d’une fiche.
Il sera demandé aux personnes utilisant les API en écriture un suivi régulier des évolutions de la plate-forme Apidae car les efforts de compatibilité ascendante ne seront pas aussi important sur ces API que sur la partie consultation.
Pour être tenu au courant des évolutions de la plateforme, merci de vous abonner à :
– status.apidae-tourisme.com (Etat général de la plateforme)
– Newsletter technique (Communications à destination des développeurs)
La bibliothèque Apidae-PHP propose des services simplifiant l’utilisation de l’authentification OAuth nécessaire à l’utilisation des API en écriture.
Configuration
Comme pour la diffusion, la mise en oeuvre des API en écriture nécessite la mise en place d’un projet d’un type spécifique. Configuration du projet L’utilisation de l’API d’écriture nécessite l’utilisation d’un projet…
v002/ecriture/
Les écritures se font objet touristique par objet touristique, via ce service d’écriture. Cette page décrit la structure générale d’une requête (hors structure des données touristiques). Des pages annexes décrivent en…
Format des objets
Afin de faciliter l’utilisation des API en écriture, les formats utilisés sont semblables aux formats utilisés en lecture. Cette page traite des spécificités lors de l’utilisation des API en écriture. Pour plus…
Multihoraire
L’écriture sur le multihoraire se fait par l’ajout d’une entrée timePeriods dans une ouverture.periodesOuvertures, lors d’un appel API écriture classique
v002/criteres-internes/
L’API de gestion des critères internes permet d’ajouter ou supprimer une liste de critères internes à une liste d’objets touristiques. Cette page décrit la structure générale d’une requête (hors structure des données…
v002/donnees-privees/
L’API de gestion des descriptifs privés permet d’ajouter ou supprimer une liste de descriptifs à une liste d’objets touristiques. Ces descriptifs sont des libellés multilingues rattachés à des champs privés. La liste des…
v002/collaborateurs/
L’API de gestion des collaborateurs permet d’ajouter ou de supprimer des membres collaborateurs sur un objet touristique.
v002/autorisation/objet-touristique/modification/
Cette méthode permet de tester avant l’écriture d’une offre si la modification sur l’offre touristique sera possible. Apidae vérifie que le projet d’écriture ou l’utilisateur dispose des droits nécessaires et qu’il n’y a…
Spécificités des multimédias (écriture)
De manière à gérer les transferts de fichiers et à autoriser des modifications partielles des fichiers associés à une fiche, la modification des champs illustrations et multimédias fait appel à des spécificités de…