City Connect.

Connexion Partenaire

Pas encore de compte ? S'inscrire

Espace Partenaire

Événements Actifs

0

Événements Passés

0

Appels API (Mois)

0

Mes Événements

Documentation de l'API Calendrier

Gérez vos événements de manière programmatique grâce à notre API REST.

Authentification & Base URL

Base URL
https://api.faircode.be
Header requis
x-api-key: VOTRE_CLE_API
GET

/api/cityconnect/calendar/events

Récupère tous les événements créés par votre clé API pour une région spécifique. Si vous avez fourni un identifiant personnalisé à la création, le champ id renverra cet identifiant d'origine.

Paramètres d'URL (Query)

NomTypeRequisDescription
postal_code String Oui Code postal de la ville ciblée.

Exemple de requête

curl -X GET "https://api.faircode.be/api/cityconnect/calendar/events?postal_code=1000" \
  -H "x-api-key: VOTRE_CLE_API"

Exemple de réponse (JSON)

{
  "count": 1,
  "events": [
    {
      "id": "mon-id-evenement",
      "title": "Festival de Jazz en Plein Air",
      "state": "approuved",
      "start_date": "2024-07-15T18:00:00.000Z",
      "end_date": "2024-07-17T23:30:00.000Z",
      "start_hour": "18:00",
      "end_hour": "23:30",
      "category": "music",
      "place": "Parc du Cinquantenaire, Bruxelles",
      "booking_status": "open",
      "target_audience": null,
      "is_accessible": true,
      "suitable_for_children": false,
      "ticketing_url": null,
      "latitude": 50.8411,
      "longitude": 4.3932,
      "image": "https://...",
      "photo": "https://...",
      "description": "Venez profiter...",
      "web": null,
      "tel": [],
      "mail": [],
      "createdAt": "2026-05-25T07:47:18.000Z"
    }
  ]
}
POST

/api/cityconnect/calendar/events

Crée un nouvel événement. Vous devez fournir les informations essentielles de l'événement, sa géolocalisation, et optionnellement un identifiant personnalisé unique.

Corps de la requête (JSON)

NomTypeRequisDescription
id String Non Identifiant personnalisé unique (max 100 caractères, alphanumérique, tirets - et underscores _). Permet de gérer l'événement avec votre propre ID de référence.
title String Oui Titre de l'événement (5 à 150 caractères).
postal_code String Oui Code postal pour définir l'instance de la ville.
category Enum Oui Catégorie. Valeurs : music, culture_arts, cinema_shows, sports_leisure, family_kids, conferences_pro, workshops_ateliers, markets_festivities, nature_outdoor, gastronomy, wellness_health, social_solidarity, other.
start_date Date Oui Date de début (Format ISO8601 : YYYY-MM-DD).
end_date Date Non Date de fin (Format ISO8601).
start_hour String Oui Heure de début (Format HH:MM).
end_hour String Oui Heure de fin (Format HH:MM).
free Boolean Oui L'événement est-il gratuit ? true ou false.
price Array[String] Cond. Requis si free est false. Liste de prix, ex: ["10€", "15€ (VIP)"].
place String Oui Nom du lieu ou adresse textuelle.
latitude Number Non Coordonnée GPS de latitude. Requis uniquement si longitude est fourni.
longitude Number Non Coordonnée GPS de longitude. Requis uniquement si latitude est fourni.
description String Non Description détaillée (max 5000 caractères).
booking_status Enum Non Statut de réservation. Valeurs : open, sold_out, canceled. Défaut: open.
target_audience String Non Public cible (ex: "Familles", "+18 ans").
is_accessible Boolean Non Accessible PMR. Défaut : null.
suitable_for_children Boolean Non Adapté pour les enfants (Kids friendly). Défaut : null.
ticketing_url String Non Lien vers la billetterie.
web String Non Site web officiel de l'événement.
tel Array[String] Non Liste des numéros de téléphone de contact.
mail Array[String] Non Liste des adresses email de contact.
image String Non URL de l'image de couverture.

Exemple de requête

curl -X POST "https://api.faircode.be/api/cityconnect/calendar/events" \
  -H "x-api-key: VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "mon-id-evenement",
    "title": "Festival de Jazz en Plein Air",
    "postal_code": "1000",
    "category": "music",
    "start_date": "2024-07-15",
    "end_date": "2024-07-17",
    "start_hour": "18:00",
    "end_hour": "23:30",
    "free": false,
    "price": ["25€/Jour", "60€/Pass 3 jours"],
    "place": "Parc du Cinquantenaire, Bruxelles",
    "latitude": 50.8411,
    "longitude": 4.3932,
    "description": "Venez profiter de 3 jours de musique jazz avec des artistes internationaux.",
    "booking_status": "open",
    "is_accessible": true,
    "suitable_for_children": false
  }'

Exemple de réponse (JSON)

{
  "message": "Événement créé avec succès",
  "eventId": "mon-id-evenement",
  "cityId": "brussels",
  "state": "approuved"
}
PUT

/api/cityconnect/calendar/events/:eventId

Modifie un événement existant. Vous n'avez besoin de fournir que les champs à mettre à jour (Mise à jour partielle). Le paramètre :eventId peut être l'ID brut Firestore ou l'ID personnalisé que vous avez fourni lors de la création.

Paramètres & Corps

NomEmplacementRequisDescription
eventId URL Path Oui L'identifiant de l'événement (ID Firestore ou ID personnalisé d'origine).
postal_code JSON Body Oui Obligatoire pour trouver l'événement dans la bonne ville.

Tous les autres champs décrits dans la méthode POST peuvent être ajoutés au JSON Body pour être modifiés.

Exemple de requête

curl -X PUT "https://api.faircode.be/api/cityconnect/calendar/events/mon-id-evenement" \
  -H "x-api-key: VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "postal_code": "1000",
    "booking_status": "sold_out",
    "title": "Festival de Jazz (COMPLET)"
  }'

Exemple de réponse (JSON)

{
  "message": "Événement mis à jour avec succès"
}
DELETE

/api/cityconnect/calendar/events/:eventId

Supprime définitivement un événement. Le paramètre :eventId peut être l'ID brut Firestore ou l'ID personnalisé d'origine.

Paramètres (URL & Query)

NomEmplacementRequisDescription
eventId URL Path Oui L'identifiant de l'événement à supprimer (ID Firestore ou ID personnalisé d'origine).
postal_code Query String Oui Le code postal de la ville.

Exemple de requête

curl -X DELETE "https://api.faircode.be/api/cityconnect/calendar/events/mon-id-evenement?postal_code=1000" \
  -H "x-api-key: VOTRE_CLE_API"

Exemple de réponse (JSON)

{
  "message": "Événement supprimé avec succès."
}

Gestion des Clés API

Gérez les clés permettant à vos applications de communiquer avec City Connect.

Ajouter une nouvelle clé

Donnez un nom à votre clé pour l'identifier facilement (ex: "Site Web", "App Mobile").