OpenAgenda met à disposition une API REST permettant de lire et d'éditer des contenu événementiels programmatiquement.

Avant de commencer à l'utiliser, assurez vous d'avoir un compte OpenAgenda activé. Vous y trouverez les clés d'accès dans votre page de paramétrage de compte.

Utilisation en lecture

L'API vous permet de lire des données événementielles de la plateforme.

Les données publiées sur OpenAgenda sont disponibles sous licence ouverte: des exports sont mis à disposition sur chaque page agenda sur les formats suivants: json, csv, xlsx, ics, rss et pdf

Utilisation en écriture

Il est possible de créer, éditer et supprimer des contenus de type événement, lieu ou agenda.

Pour commencer à utiliser l'API en écriture, envoyez une demande a support@openagenda.com pour activer un accès à une clé privée qui vous permettra ensuite de suivre une procédure d'authentification de type OAuth pour récupérer un token d'accès valide nécessaire aux opérations d'écriture.

Une fois que vous avez un token d'accès valide, vous pouvez gérer des lieux, événements et agendas. Gardez en tête les points suivants:

  • Avant de publier des événements, vous aurez besoin de créer les lieux où ils se dérouleront
  • Si vous voulez utiliser l'api a des fin de test, écrivez 'test' dans vos titres et placez une valeur booléenne vrai sous une clé 'test' dans vos requêtes.
  • Dans le cas où vous auriez besoin de faire appel à l'api avec une intensité certaine, faite le pendant la nuit pour réduire la charge pendant les périodes de forte utilisation.

Pour débuter:

  • Commencez par lire la section sur l'authentification en écriture
  • Poursuivez par la création de lieux - gardez les uids des lieux créés pour les utiliser lors de la création des événements
  • Créez votre événement