Aperçu

Présentation générale de l'API version 1.0

Paramètres du compte

Les paramètres d'API des utilisateurs permettant d'accéder à l'API se trouvent dans le compte de chaque utilisateur.
  • API Endpoint - L'URL où les utilisateurs accèdent à l'API de l'agenda.
  • Nom d'utilisateur - Nom d'utilisateur de l'agenda.
  • Clé - Clé d'API de l'agenda.
La clé API peut être réinitialisée lors de l'enregistrement des paramètres de votre compte.

Remarque: Le nom d'utilisateur pour un compte de calendrier donné dépend du type de compte avec lequel l'utilisateur se connecte (Facebook, Twitter ou Google).

Authentification

Pour lire les données de l'API, les utilisateurs doivent authentifier leur demande en utilisant leur nom d'utilisateur et leur clé API.

Exemple de requète

https://sortiraujourdhui.fr/api/?u=YOUR_USERNAME&k=YOUR_KEY

Méthodes

L'API prend actuellement en charge les méthodes suivantes:

Événements

  • Actualités - events_c
  • Billboard Events - événements_b
  • Evénements populaires - events_p
  • Nouveaux événements - events_n

Catégories

  • Hiérarchique - categories_h
  • Alphabétique - categories_a
  • Nombre d'événements - categories_e

En-tête de réponse

En raison des variations potentielles dans la version (ou la personnalisation) de l'API utilisée, chaque réponse d'API comprend un en-tête de résumé contenant des informations pertinentes sur le site fournissant la réponse. Cette information est fournie pour permettre aux développeurs d'API de prendre en compte les variations qui peuvent survenir.

  • version - Version de l'API utilisée sur le calendrier.
  • cal_url - URL complète du calendrier public.
  • encoding - Jeu de caractères utilisé sur le calendrier (et l'API).
  • généré - Timestamp (ISO 8601) lorsque les données de réponse ont été générées. Le calendrier utilisant l'une des options de cache de l'API contiendra l'horodatage lors de la dernière reconstruction du cache.
  • contenu - Description du contenu de la réponse (événements / catégories / erreur / etc.).

Erreurs

Si un appel d'API aboutit à autre chose qu'un ensemble de données renvoyé valide, une réponse d'erreur détaillée sera fournie.
Exemple de réponse
{
   "api": {
	  "version": "1.0",
	  "cal_url": "URL",
	  "encoding": "CHARACTER_SET",
	  "generated": "ISO_8601_TIMESTAMP",
	  "contents": "RESPONSE_DESC"
   },
   "Erreur":{
	  "error_id": "ERROR_ID",
	  "msg": "ERROR_MESSAGE",
	  "help": "HELP_MESSAGE"
   }
}

Si vous ne trouvez pas de réponse à vos questions, envoyez-nous un message. Nous y répondons du lundi au vendredi:

Envoyer un mail