Récupérer la clé d’identification de votre municipalité

Pour récupérer votre clé d’identification, via le site de gestion d’alertes et notifications, rendez-vous dans le menu « Municipalité » / « Configuration ».
Dans la section « Portail citoyen », prenez l’ID qui se trouve à la fin de l’URL. Il s’agirat du « CityID » à passer dans les paramètres de l’API.

URL de l’API

PROD : https://portailcitoyen.cauca.ca

Récupération de la liste des alertes

Paramètres

GET: /api/AlertList
- Header obligatoire :
  - “Language-Code” : valeurs possibles: fr, en et es (pour français, anglais et espagnol)
- Query params, tous obligatoires :
  - CityId : c’est la clé d’identification de la municipalité
  - Status :
    - Valeur possibles:
      - 0 = alertes en cours
      - 1 = alertes terminées
  - pageSize : nombre d’alertes retournées
  - page : la page qu’on veut récupérer

À propos des pages: si on dit qu’on veut la page 2 avec un page size de 10 et qu’il y a au total 30 alertes, ça veut dire qu’on recevra les alertes 10 à 20. Bref on peut se servir de ça ainsi que du count reçu (voir ci-dessous) pour implémenter un « paginator ».

Structure de l’objet retourné par cette requête

{
  "alerts": [
    {
      "id": "678fd75d-3810-4335-b223-be2e60a747b7",
      "title": "Levée de l'avis d'ébullition",
      "type": "Avis d'ébullition",
      "color": null,
      "description": "L’avis d’ébullition de l’eau potable dans le secteur de la rue Mercure est maintenant levé.",
      "status": 0,
      "date": "2025-08-21T11:57:14.550518-04:00",
      "picturePath": null,
      "customIconPath": null,
      "iconName": "fal cauldron"
    },
    {
      "id": "dd730e32-c84b-4968-8e4f-713d8ac6e5e6",
      "title": "Levée interdiction d'arrosage.",
      "type": "Interdiction d'arrosage",
      "color": null,
      "description": "Ceci est un message automatisé de la Ville. À titre de rappel, un règlement est en place et il est important de le respecter.",
      "status": 0,
      "date": "2025-08-18T13:49:45.010398-04:00",
      "picturePath": null,
      "customIconPath": null,
      "iconName": "fal bullhorn"
    }
  ],
  "count": 2
}

count : nombre total d’alerte pour le statut spécifié dans la municipalité
alerts (liste) :
- id : l’identifiant de l’alerte
- title : titre de l’alerte
- type : le type de l’alerte
- color : la couleur liée au type de l’alerte
- description : le texte de l’alerte sans son formatage html, sans image, pour en faire un preview
- status : le statut de l’alerte: 0 = en cours, 1 = terminées
- date : la date de l’alerte
- picturePath : image de l’alerte, peut être null
- customIconPatch : Lien avec un icône personnalisé du client.
- iconName : Le nom d’un icône de font awesome.

Exemple CURL

curl -H "Language-Code: fr" "https://portailcitoyen.cauca.ca/api/AlertList?status=0&pageSize=6&page=1&cityId=a9b0db68-cf03-4d2e-9fab-31f6b92c0344"

Récupération d’une alerte

Adresse et paramètres

GET /api/alerts/{id}
- {id} doit être remplacé par l’identifiant de l’alerte récupéré via la liste des alertes.
- Header obligatoire:
  - “Language-Code” : valeurs possibles: fr, en et es (pour français, anglais et espagnol)

Structure de l’objet retourné

{
  "id": "678fd75d-3810-4335-b223-be2e60a747b7",
  "title": "Levée de l'avis d'ébullition",
  "type": "Avis d'ébullition",
  "color": null,
  "description": "<p>L&rsquo;avis d&rsquo;&eacute;bullition de l&rsquo;eau potable dans le secteur de la rue Mercure est maintenant lev&eacute;</p>",
  "status": 0,
  "date": "2025-08-21T11:57:14.550518-04:00",
  "picturePath": null,
  "iconName": "fal cauldron",
  "customIconPath": null
}

id : l’identifiant de l’alerte
title : titre de l’alerte
type : le type de l’alerte
color : la couleur liée au type de l’alerte
description : le texte de l’alerte en format html. Peut contenir des liens vers des images
status : le statut de l’alerte: 0 = en cours, 1 = terminées
date : la date de l’alerte
picturePath : image de l’alerte, peut être null
customIconPatch : Lien avec un icône personnalisé du client.
iconName : Le nom d’un icône de font awesome.

Exemple en CURL

curl -H "Language-code: fr" "https://portailcitoyen.cauca.ca/api/alerts/678fd75d-3810-4335-b223-be2e60a747b7"

API - Afficher les alertes sur le site web de la municipalité