API flux sortant beta

La version actuelle de l'API est 2.0.



Note:

  • seuls les événements de l'organisateur·trice sont exportés dans le flux sortant.
  • seuls les événements publiés dans le culturoscoPe sont exportés (les événements figurant dans l'agenda prévisionnels n'apparaissent pas dans le flux).
  • les événements ponctuels sont exportés par ordre chronologique, les événements se déroulant sur plusieurs jours (expositions) apparaissent en fin de flux.

3 types de flux sortants

Le flux gratuit (G) permet d’exporter la liste des événements filtrés par dates et catégories et de renvoyer vers le site de l’organisateur ou vers la page de détail du culturoscoPe.

Chaque membre (M) peut exploiter ses propres données et les récupérer via un flux.

Les partenaires (P) peuvent récupérer les données du culturoscoPe et les exploiter selon des modalités et des tarifs encore à définir.

Appel

URL: https://www.culturoscope.ch/api/2.0/events.php?api_key=VOTRE_CLEF_API
(variables $_GET)

Paramètre Valeur Description Valeur par défaut Dispo pour
output json, xml, text Format de sortie json G/M/P
start_date YYYY-mm-dd Date de début des événements date du jour G/M/P
end_date YYYY-mm-dd Date de fin des événements G/M/P
group_dates 0 ou 1 Défini si les dates des représentations sont groupées dans le tableau event_dates (1) ou si elles sont exportées comme des enregistrements distincts (0) 1 G/M/P
categories AN, CI, DA, EX, LI, MU, PA, PR, TH Catégories d'événements à exporter séparées par des virgules Si vide, toutes les catégories sont sélectionnées G/M/P
zones JB, JU, BI, NE Zones d'événements à exporter séparées par des virgules Si vide, toutes les zones sont sélectionnées G/P
zip Code postal des événements à exporter P
flags CREATION, YOUNGPUBLIC Labels des événements à exporter séparée par des virgules Si vide, tous les labels sont sélectionnés P

Valeurs retournées

ChampTypeDescription Dispo pour
event_idIntegerID de l'événement G/M/P
event_titleVarcharTitre de l'événement

Pour les événements figurant dans l'agenda prévisonnel le titre n'est pas requis
G/M/P
event_descriptionTextDescription de l'événementM/P
event_categoriesArrayTableau contenant les codes des catégories

Vocabulaire:
AN: Animation
CI: Cirque
DA: Danse
EX: Exposition
LI: Littérature
MU: Musique
PA: Patrimoine
PR: Projection
TH: Théâtre
G/M/P
event_category_labelVarcharTexte libre pour le libellé de la catégorieG/M/P
event_statusVarcharStatut de publication

Valeurs possibles:
PUBLIC: Publié dans le culturoscoPe et dans l'agenda prévisionnel
PRIVATE: Publié uniquement dans l'agenda prévisionnel dont l'accès est réservé aux organisateurs·trices

Valeur par défaut: PUBLIC
M/P
event_datesArrayTableau contenant les objets de type «date» G/M/P
event_flagsArrayTableau des labels (jeune public, création, …)M/P
detail_urlURLURL complète de la page de détail de l'événement sur le site de l'organisateur·trice

EX: https://www.culturoscope.ch/evt/1974
G/M/P
image_urlURLURL complète de l'image

EX: https://www.culturoscope.ch/img/mon_image.jpg
G/M/P
image_creditVarcharCrédit photographique de l'imageG/M/P
booking_urlURLURL complète de la billeterieM/P
booking_phoneURLNuméro de téléphone pour la réservationM/P
booking_mailURLAdresse e-mail pour la réservationM/P
venue_nameVarcharNom du lieu où se déroule l'événement

Valeur par défaut: nom du lieu de l'organisateur·trice défini dans son profil culturoscoPe
G/M/P
venue_addressVarcharAdresse postale du lieu où se déroule l'événement

Valeur par défaut: adresse de l'organisateur·trice
M/P
venue_zipIntegerCode postal du lieu où se déroule l'événement

Valeur par défaut: code postal de l'organisateur·trice
M/P
venue_cityVarcharLocalité du lieu où se déroule l'événement

Valeur par défaut: Localité de l'organisateur·trice
G/M/P
zoneVarcharCode de la zone où se déroule l'événement (Ex: JB, JU, BI, NE)P
culturoscope_urlURLURL complète de la page de détail de l'événement sur le culturoscoPeG/M/P
event_categories_labelsARRAYTableau contenant les intitulés des catégories du culturoscoPe
event_flags_labelsARRAYTableau contenant les intitulés des labels du culturoscoPeP
Les informations ci-dessus sont générées dynamiquement et représentent l'état actuel du culturoscoPe (version 2.0).