Clés & IDs

Votre compte OneSignal inclut à la fois des IDs publics et des clés API privées qui sont essentiels pour configurer vos applications et accéder à l’API OneSignal. Ce guide explique où les trouver, comment les gérer et les meilleures pratiques pour une utilisation sécurisée.

---

​

ID d’application

L’ID d’application est un identifiant public unique pour votre projet OneSignal, formaté en UUID v4. Il est distinct de vos clés API privées et est requis pour :

• Initialisation du SDK – Configuration du SDK Mobile, Configuration du SDK Web
• Appels API – Créer un message, Créer un utilisateur, et autres.

Trouvez votre ID d’application sous Paramètres > Clés & IDs dans le tableau de bord OneSignal ou via l’API Voir les applications.

​

ID d’organisation

Votre ID d’organisation (Org ID) est un identifiant unique au format UUID v4 qui regroupe toutes les applications sous votre plan de facturation. Il est requis pour les API liées à :

• Gestion des applications – Créer une application, Mettre à jour une application.

Vous pouvez trouver votre organization_id dans le tableau de bord sous Organizations > Votre organisation ou via l’API Voir une application.

---

​

Clés API

Il existe deux types de clés API :

1. Clés API d’application
2. Clé API d’organisation – Une clé privée utilisée pour configurer les applications et les clés API au sein d’une organisation.

​

Clé API d’application

Votre clé API d’application est une clé privée utilisée pour la plupart des requêtes API REST liées à une application spécifique.

• Les clés API d’application peuvent être créées sous Paramètres > Clés & IDs ou Créer une clé API.
• Elles ne peuvent être consultées qu’une seule fois après création.
• Incluez cette clé dans l’en-tête Authorization en utilisant le schéma d’authentification key :
  Copier

  Demander à l'IA

  Authorization: key YOUR_REST_API_KEY
  

​

Clé API d’organisation

Votre clé API d’organisation est une clé privée utilisée pour gérer les applications et les clés API d’application au sein d’une organisation. Elle est requise pour les requêtes API telles que :

• Configuration d’application – Créer des applications, Voir les applications
• Gestion des clés API – Créer une clé API, Supprimer une clé API, Mettre à jour une clé API

Pour créer une clé API d’organisation, accédez à Organizations > votre org > Clés & IDs dans votre tableau de bord OneSignal. Comme pour les clés API d’application, vous pouvez configurer jusqu’à 16 clés d’organisation et inclure une configuration de liste d’autorisation IP.

---

​

Créer des clés API

• Clé API d’application – Accédez aux Paramètres > Clés & IDs de votre application ou utilisez l’API Créer une clé API.
• Clé API d’organisation – Accédez à la section Clés & IDs de votre organisation.

Cliquez sur Ajouter une clé pour ouvrir le modal de création. Donnez à votre clé un nom descriptif (par exemple, “Service de synchronisation CRM”).

​

Liste d’autorisation IP

Optionnellement, restreignez l’utilisation de la clé API à des adresses IP spécifiques en activant la liste d’autorisation IP. Entrez des blocs CIDR séparés par des espaces (par exemple, 192.0.2.0/24 192.0.2.123/32). Les requêtes provenant d’adresses IP non autorisées seront refusées.

​

Afficher les clés API

Après avoir cliqué sur Créer, votre clé API sera affichée une seule fois. Enregistrez-la en toute sécurité. Après avoir cliqué sur Continuer, la clé ne sera plus consultable.

---

​

Gestion des clés

Après avoir créé une clé, vous pouvez la gérer via l’interface de liste des clés :

​

Modifier les clés API

Via le tableau de bord ou l’API Mettre à jour une clé API :

• Mettre à jour le nom ou la liste d’autorisation IP
• Ne modifie pas le secret—aucun changement de code d’application nécessaire

​

Faire pivoter les clés API

Via le tableau de bord ou l’API Faire pivoter une clé API :

• Remplace le secret de la clé
• Conserve le même nom et les mêmes paramètres IP
• Vous devez mettre à jour votre application ou intégration avec la nouvelle clé

​

Supprimer les clés API

Via le tableau de bord ou l’API Supprimer une clé API :

• Supprime la clé définitivement
• Bloque tout accès API ultérieur utilisant cette clé

---

​

Migration depuis les clés API héritées

Nous avons introduit la gestion enrichie des clés API le 14 novembre 2024. Étapes de migration

1. Créez une nouvelle clé API enrichie (voir ci-dessus).
2. Remplacez la clé héritée dans votre code.
3. Mettez à jour les appels API pour utiliser https://api.onesignal.com au lieu de l’ancienne URL https://onesignal.com/api/v1/.
4. Supprimez ou cliquez sur “Désactiver la clé héritée” sur la clé héritée depuis la page Clés & IDs.

---

​

Désactivation de votre application

Vous pouvez supprimer vos clés API pour empêcher tout accès ultérieur à l’API REST en utilisant cette clé. Vous pouvez empêcher votre application d’envoyer des messages via Paramètres > Gérer l’application > Boutons de désactivation de l’application. Consultez Applications et organisations désactivées pour plus de détails.

---