Historique de la page

Connecteur appelé par le module notifications

Enregistrement du token FCM de l’utilisateur

Paramètres d'appels

URL en méthode POST

<host>/<uri>/register

• host : adresse du serveur
• uri : chemin éventuel vers le service

Body de la requête :

{
  username: String, 
  token: String,   
  platform: String, 
  ip: String        
}

...

HTTP 4xx ou 5xx : En cas de problème ou erreur

Suppression du token FCM de l’utilisateur (lors du logout)

Paramètres d'appels

URL en méthode POST

<host>/<uri>/unregister

• host : adresse du serveur
• uri : chemin éventuel vers le service

Body de la requête :

{
  username: String, 
  token: String     
}

...

HTTP 4xx ou 5xx : En cas de problème ou erreur

Récupération des notifications de l’utilisateur

Paramètres d'appels

URL en méthode GET

<host>/<uri>/notifications/<username>
<host>/<uri>/notifications/<username>?offset=0&length=10

• host : adresse du serveur
• uri : chemin éventuel vers le service
• username : Login de l'utilisateur (obligatoire)
• offset : offset de la prochaine notification à récupérer. Les notifications seront triées de la plus récente à la plus ancienne.
• length : nombre de notifications à récupérer à partir de l’offset

Par défaut, si les paramètres offset et length ne sont pas renseignés, l’API retournera les 20 notifications les plus récentes.

...

HTTP 4xx ou 5xx : En cas de problème ou erreur

Marquer une ou plusieurs notifications comme lues

Paramètres d'appels

URL en méthode POST

<host>/<uri>/notifications/read

• host : adresse du serveur
• uri : chemin éventuel vers le service

Body de la requête :

{
  username: String,           
  notificationId: [String]
}

...

HTTP 4xx ou 5xx : En cas de problème ou erreur

Marquer une ou plusieurs notifications comme non lues (pas utilisée)

Paramètres d'appels

URL en méthode POST

<host>/<uri>/notifications/unread

• host : adresse du serveur
• uri : chemin éventuel vers le service

Body de la requête :

{
  username: String,           
  notificationId: [String]
}

...

HTTP 4xx ou 5xx : En cas de problème ou erreur

Récupérer la liste des canaux pour lesquels l’utilisateur a désactivé les notifications

Paramètres d'appels

URL en méthode GET

<host>/<uri>/channels/{username}

• host : adresse du serveur
• uri : chemin éventuel vers le service
• username : Login de l'utilisateur (obligatoire)

Format de retour

Format attendu

...

HTTP 4xx ou 5xx : En cas de problème ou erreur

Gérer les abonnements de l’utilisateur au canaux

Paramètres d'appels

URL en méthode PATCH

<host>/<uri>/channels

• host : adresse du serveur
• uri : chemin éventuel vers le service

Body de la requête :

{
  username: String,       
  channels: [String],      
}

...

HTTP 4xx ou 5xx : En cas de problème ou erreur

Supprimer une notification

Paramètres d'appels

URL en méthode DELETE

<host>/<uri>/notifications

• host : adresse du serveur
• uri : chemin éventuel vers le service

Body de la requête :

{
  username: String,           
  notificationId: String
}

...