Introduction
OpenAgenda met à disposition une API REST permettant de lire et d'éditer des contenus événementiels programmatiquement.
Les données des agendas publiés sont disponibles sous licence ouverte. Des exports sont disponibles sous plusieurs formats : PDF, tableur, ICS, texte.
Bien que l'utilisation de l'API soit gratuite, elle requiert une authentification que ce soit en consultation ou en édition. Cette contrainte nous permet de lutter plus efficacement contre les usages abusifs.
Pour en savoir plus sur l'authentification, rendez-vous ici
Entités principales
Agendas
OpenAgenda permet de gérer des contenus événementiels dans des agendas. Ces agendas sont administrés une communauté de modérateurs ou administrateurs qui décident de la configuration du formulaire de saisie, du circuit de contribution à suivre par les contributeurs avec qui ils peuvent converser via une messagerie propre à l'agenda. Les agendas peuvent être découverts via la route suivante:
https://api.openagenda.com/v2/agendas
La configuration d'un agenda peut être consultée via la route suivante:
https://api.openagenda.com/v2/agendas/{agendaUID}
Rendez-vous ici pour plus de détails.
Événements
Les événements d'un agenda peuvent être consultés, édités, publiés, recherchés via le groupe de routes suivant:
https://api.openagenda.com/v2/agendas/{uid}/events
Rendez-vous ici pour plus de détails.
Lieux
Les lieux d'un agenda peuvent être consultés, édités, supprimés via le groupe de routes suivant:
https://api.openagenda.com/v2/agendas/{uid}/locations
Rendez-vous ici pour plus de détails.
Pour bien démarrer
Pour commencer à utiliser l'API OpenAgenda :
- Créez un compte si vous n'en avez pas
- Récupérez votre clé API dans vos paramètres
- Consultez la section Authentification pour apprendre à utiliser votre clé
- Explorez la section Agendas pour voir comment consulter et éditer les agendas
- Explorez la section Événements pour comment consulter et éditer les événements publiés sur les agendas