Tokens de Notification (NotificationTokenApi)
Le module NotificationTokenApi permet de gérer les tokens de notification push des clients pour envoyer des notifications sur leurs appareils.
Accès : client.notificationToken
Méthodes
set
Enregistre ou met à jour un token de notification pour un client.
Exemple
const response = await client.notificationToken.set({
appId: "app_id",
apiKey: "user_api_key",
customerId: "cust_123",
token: "fcm_token_abc123...",
platform: "ANDROID",
deviceId: "device_unique_id",
deviceName: "Samsung Galaxy S21"
});
console.log(`Token enregistré: ${response.data.id}`);Si le token existe déjà, il sera mis à jour avec les nouvelles informations d’appareil.
remove
Supprime un token de notification spécifique (déconnexion d’un appareil).
Exemple
const response = await client.notificationToken.remove({
appId: "app_id",
apiKey: "user_api_key",
customerId: "cust_123",
token: "fcm_token_abc123..."
});
if (response.data.removed) {
console.log("Token supprimé - Appareil déconnecté");
}removeAll
Supprime tous les tokens d’un client (déconnexion de tous les appareils).
Exemple
const response = await client.notificationToken.removeAll({
appId: "app_id",
apiKey: "user_api_key",
customerId: "cust_123"
});
console.log(`${response.data.removedCount} appareil(s) déconnecté(s)`);Utilisez cette méthode avec précaution. Elle déconnecte le client de tous ses appareils.
list
Liste tous les tokens de notification d’un client.
Exemple
const response = await client.notificationToken.list({
appId: "app_id",
apiKey: "user_api_key",
customerId: "cust_123"
});
// Afficher les appareils connectés
response.data.forEach(token => {
console.log(`${token.deviceName ?? 'Appareil inconnu'} (${token.platform})`);
});Plateformes supportées
| Plateforme | Description |
|---|---|
IOS | Apple Push Notification service (APNs) |
ANDROID | Firebase Cloud Messaging (FCM) |
WEB | Web Push Notifications |
Gestion des erreurs
| Code erreur | Description |
|---|---|
customer-not-found | Le client n’existe pas |
not-authorized | La clé API n’a pas les droits nécessaires |
invalid-request | Token ou plateforme invalide |
Last updated on