La passerelle est une collection de scripts Airtable permettant d'interagir avec WordPress.
Alors qu’Airtable est de plus en plus utilisé par les organisations culturelles, les besoins d’interaction entre ce système de gestion de bases de données et le CMS WordPress sont grandissants. Qu’il s’agisse de publier un répertoire de membres, d’oeuvres ou de spectacles sur le web, le besoin d’allier la simplicité de gestion des données d’Airtable avec les fonctionnalités de publication de contenu de WordPress sont fréquents.
C’est pour répondre à ce genre de besoins que RAPAIL développe La passerelle: un coffre à outils pour l’intégration de WordPress et Airtable. RAPAIL souhaite évidemment répondre à ses propres besoins. Elle souhaite également faire profiter la communauté culturelle québécoise des travaux qu’elle entreprend.
Le présent dépôt de code contient des extraits de scripts Airtable utilisés par RAPAIL pour synchroniser les données de sa base Airtable avec son site web sous WordPress. Ce code, qui s’appuie sur différentes principes pour répondre à une série de besoins tout en répondant à des contraintes, est complété par une documentation offrant des scénarios d’utilisation en réponse à des besoins types.
Ce projet a été rendu possible grâce à l'appui du programme Exploration et déploiement numérique du Conseil des arts et des lettres du Québec, et du programme Innovation et développement du secteur du Conseil des arts du Canada.
L'utilisation de La passerelle demande de compléter plusieurs étapes de configuration dans Airtable et dans WordPress. Ces étapes sont présentées dans le guide de démarrage et d'installation
Les outils de synchronisation devront être personnalisés selon vos besoins.
Il s'agit essentiellement de créer des extensions (pour les synchronisation déclenchées manuellement) ou des automatisations (pour les synchronisations déclenchées de façon périodique, ou en réaction à un déclencheur externe à la base de données) qui utiliseront le script principal, en lui envoyant des paramètres qui permettront de faire des choix sur les données à synchroniser (la table, les champs et les enregistrements ciblés, et les correspondances avec les éléments équivalents dans WordPress).
Dans tous les cas, il s'agit de faire un appel au lien HTTP («webhook») du script principal, en utilisant des valeurs adaptées dans la variable params. Les options de la variable params sont documentées dans la section API. Le lien HTTP peut être appelé depuis une extension, une automatisation, ou même une application externe.
La Passerelle doit stocker certaines métadonnées relatives aux informations disponibles dans WordPress et dans Airtable et pour garder des traces des identifiants de contenus et de médias dans les deux système. Il est donc essentiel de prévoir un champ de type «Long text» dans les tables à synchroniser. Par défaut, le script cherche les données dans un champ nommé «meta», mais il est possible de spécifier un autre nom de champ. Cette option, et d'autres options liées à la consignation de métadonnées de la synchroniser (date de dernière synchronisation, URL du contenu dans WordPress, etc.), sont documentées dans la section API.
La page dédiée à l'API contient les références détaillées sur les options du script, le types de champs, etc.
La foire aux questions offre des solutions à des problèmes connus du script, ou des suggestion d'approches pour répondre à des besoins spécifiques de synchronisation de données.
Des exemples de script sont disponibles.
Si vous rencontrez un problème («bogue») en utilisant La Passerelle, ou si vous avez une idée d'une nouvelle fonctionnalité utile, nous vous invitons à documenter le besoin dans la section Issues. Soyez le plus précis possible. Dans le cas d'un bogue, il sera utile de décrire précisément les données, la configuration de La Passerelle, le message d'erreur ou le comportement détaillé, et ce qui était attendu.
Les contributions au code ou à la documentation de La Passerelle sont bienvenues! Pour contribuer:
- Faites un «fork» du projet.
- Apportez les modifications (et testez les, dans le code de changements au code).
- Faites une «pull request» sur vos modifications.
Au moment de démarrer le projet, la seule option disponible pour intégrer des données depuis Airtable dans WordPress était l’extension Airpress. Elle a depuis été retirée de l'écosystème WordPress.
Cette extension présentait par ailleurs des limitations fonctionnelles (notamment le fait que les données ne soient pas synchronisées sous la forme de contenus natifs WordPress), en plus de ne pas être supportée par son développeur.
Pour répondre à des objectifs de maintenabilité, notre projet tente de répondre aux différents besoins sans développer d’extension WordPress, ou ajouter dans le projet WordPress des dépendances sur des extensions qui ne sont pas largement utilisée (et donc avec une bonne probabilité d’être maintenue à long terme).
En cas de litige, seule la version originale de cette page a valeur juridique.
Copyright 2022 A10s inc. et RAPAIL
La présente autorise, de façon libre et gratuite, à toute personne obtenant une copie de ce programme et des fichiers de documentation associés (le Programme), de distribuer le Programme sans restriction, y compris sans limitation des droits d'utiliser, copier, modifier, fusionner, publier, distribuer, sous-autoriser ou vendre des copies du Programme, et de permettre aux personnes à qui le Programme est fourni d'en faire autant, aux conditions suivantes.
Le copyright précédent et cette autorisation doivent être distribués dans toute copie entière ou substantielle de ce Programme.
Le Programme est fourni en l'état, sans garantie d'aucune sorte, explicite ou implicite, y compris les garanties de commercialisation ou d'adaptation dans un but particulier et l'absence de contrefaçon. En aucun cas les auteurs ou ayants droit ne seront tenus responsables de réclamations, dommages ou autres, que ce soit dans une action de nature contractuelle, préjudiciable ou autres façons, découlant de, hors ou en connexion avec le Programme ou l'utilisation ou autres modifications du Programme.