Notification Paytou API

Service de notifications push robuste et performant pour vos applications. Envoyez des notifications via Firebase Cloud Messaging avec une API REST sécurisée et complète.

Documentation Swagger

Base URL: http://localhost:4205/api

Fonctionnalités Principales

Notifications Push

Envoyez des notifications push via Firebase Cloud Messaging (FCM) à des utilisateurs individuels ou en groupe avec une API REST sécurisée.

Gestion des Utilisateurs

Gérez les tokens FCM des utilisateurs et envoyez des notifications ciblées à des groupes ou individus avec un système complet.

Templates de Notifications

Créez et gérez des templates de notifications réutilisables pour standardiser vos messages et améliorer l'engagement.

Suivi des Envois

Suivez le statut de chaque notification envoyée avec historique complet et statistiques de livraison en temps réel.

WebSockets Temps Réel

Communication en temps réel avec Socket.io pour recevoir des notifications instantanées et gérer les connexions actives.

Rate Limiting

Protection contre les abus avec limitation du nombre de requêtes par minute pour garantir la stabilité.

Services Disponibles

Envoi de Notifications

Envoyez des notifications push via JSON ou Form Data avec images

POST /api/firebase/notifications/send
POST /api/firebase/notifications/send-with-image

Topics & Broadcast

Envoyez à des topics ou diffusez à toute une application

POST /api/firebase/notifications/topic/:topic
POST /api/firebase/notifications/broadcast/:appId

Gestion des Topics

Abonnez/désabonnez des utilisateurs aux topics Firebase

POST /api/firebase/topics/subscribe
POST /api/firebase/topics/unsubscribe
POST /api/firebase/topics/auto-subscribe

Statistiques

Obtenez les statistiques des tokens FCM enregistrés

GET /api/firebase/stats

Flux d'Envoi de Notification

1

Préparation

Préparez votre notification avec titre, corps, données personnalisées et image optionnelle via l'endpoint POST /firebase/notifications/send.

2

Ciblage

Ciblez vos utilisateurs par userId, userIds, tokens FCM spécifiques ou topic Firebase pour un envoi groupé.

3

Envoi via FCM

L'API récupère les tokens FCM des utilisateurs ciblés et envoie la notification via Firebase Cloud Messaging.

4

Livraison

Firebase Cloud Messaging livre la notification aux appareils des utilisateurs ciblés (mobile, web, etc.).

5

Réponse

Vous recevez une réponse avec le messageId, le nombre de notifications envoyées et les éventuelles erreurs.

Sécurité & Authentification

Firebase Cloud Messaging

Intégration complète avec Firebase Cloud Messaging (FCM) pour l'envoi sécurisé de notifications push sur tous les appareils.

Rate Limiting

Limitation à 100 requêtes par minute pour protéger contre les abus et garantir la stabilité du système.

Validation

Validation complète des entrées avec class-validator et transformation automatique des données.

Helmet

Headers de sécurité configurés avec Helmet pour protéger contre les vulnérabilités courantes.

CORS

Configuration CORS flexible pour autoriser les requêtes depuis vos domaines autorisés.

Logging

Traçabilité complète de toutes les requêtes API et callbacks pour audit et debugging.