> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Configuration du SDK Capacitor
> Configurez le SDK OneSignal Capacitor pour ajouter des notifications push aux applications Capacitor pour iOS et Android.
export const SdkReleasesIframe = ({sdkFilter = undefined, viewMode = undefined, height, ...frameProps}) => {
const baseUrl = 'https://onesignal.github.io/sdk-releases';
const buildUrl = (theme, sdkFilter, viewMode) => {
const url = new URL(baseUrl);
const params = new URLSearchParams();
if (theme) {
params.set('theme', theme);
}
if (sdkFilter) {
params.set('sdk', sdkFilter);
}
if (viewMode) {
params.set('viewMode', viewMode);
}
if (params.toString()) {
url.search = params.toString();
}
return url.toString();
};
const detectTheme = () => {
if (document.documentElement.classList.contains('dark')) {
return 'dark';
}
return 'light';
};
const [theme, setTheme] = useState('light');
const [iframeSrc, setIframeSrc] = useState(() => {
const initialTheme = detectTheme();
return buildUrl(initialTheme, sdkFilter, viewMode);
});
useEffect(() => {
const currentTheme = detectTheme();
setTheme(currentTheme);
setIframeSrc(buildUrl(currentTheme, sdkFilter, viewMode));
const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)');
const handleThemeChange = () => {
const newTheme = detectTheme();
setTheme(newTheme);
setIframeSrc(buildUrl(newTheme, sdkFilter, viewMode));
};
if (mediaQuery.addEventListener) {
mediaQuery.addEventListener('change', handleThemeChange);
} else {
mediaQuery.addListener(handleThemeChange);
}
window.addEventListener('storage', handleThemeChange);
const observer = new MutationObserver(handleThemeChange);
observer.observe(document.documentElement, {
attributes: true,
attributeFilter: ['class', 'data-theme']
});
return () => {
if (mediaQuery.removeEventListener) {
mediaQuery.removeEventListener('change', handleThemeChange);
} else {
mediaQuery.removeListener(handleThemeChange);
}
window.removeEventListener('storage', handleThemeChange);
observer.disconnect();
};
}, [sdkFilter, viewMode]);
const getIframeHeight = () => {
if (viewMode === 'table') {
return '450';
}
if (viewMode === 'mini') {
return '170';
}
return '800';
};
const iframeHeight = height || getIframeHeight();
return
;
};
## Aperçu
Ce guide explique comment intégrer les notifications push OneSignal dans une application Capacitor ou Ionic Capacitor. Il couvre l'installation, l'initialisation du SDK et la configuration de plateforme requise.
***
## Exigences
* Capacitor v7+
* Application et plateforme OneSignal configurées
**Exigences iOS**
* macOS avec Xcode 14+ (les instructions de configuration utilisent Xcode 16.2)
* Appareil avec iOS 12+, iPadOS 12+, ou simulateur Xcode exécutant iOS 16.2+
* CocoaPods 1.16.2+
**Exigences Android**
* Appareil Android 7.0+ ou émulateur avec Google Play Store (Services) installé
Le nom de l'application ne doit pas contenir d'espaces (p.ex. « MyApp » au lieu de « My App ») pour éviter les problèmes de compilation.
### Configurer votre application OneSignal et votre plateforme
Configurez votre application OneSignal avec les plateformes que vous prenez en charge — Apple (APNs), Google (FCM), Huawei (HMS) et/ou Amazon (ADM).
Si votre organisation possède déjà un compte OneSignal, [demandez à être invité](/docs/en/manage-team-members) à l'Organisation. Sinon, [inscrivez-vous pour un compte gratuit](https://onesignal.com) pour commencer.
Créez une nouvelle application en cliquant sur **New App/Website**, ou ajoutez une plateforme à une application existante dans **Settings > Push & In-App**. Sélectionnez la ou les plateformes que vous souhaitez configurer et cliquez sur **Next: Configure Your Platform**.
Entrez les identifiants pour votre plateforme :
* **Android** : [Configurer les identifiants Firebase](/docs/en/android-firebase-credentials)
* **iOS** : [Jeton p8 (Recommandé)](/docs/en/ios-p8-token-based-connection-to-apns) ou [Certificat p12](/docs/en/ios-p12-generate-certificates)
* **Amazon** : [Générer une clé API](/docs/en/generate-an-amazon-api-key)
* **Huawei** : [Autoriser OneSignal](/docs/en/authorize-onesignal-to-send-huawei-push)
Cliquez sur **Save & Continue** après avoir saisi vos identifiants.
Votre **App ID** est affiché sur l'écran final. Copiez et enregistrez-le — vous en avez besoin lors de l'initialisation du SDK. Sélectionnez votre plateforme SDK, puis suivez le guide de configuration.
***
## Configuration du SDK
### 1. Ajouter le SDK
Ajoutez le package `@onesignal/capacitor-plugin` à votre projet.
```shell theme={null}
npm install @onesignal/capacitor-plugin
npx cap sync
```
### Facultatif : désactiver le module de localisation
À partir de `@onesignal/capacitor-plugin` 1.1.0, vous pouvez exclure le module de localisation natif de OneSignal des builds iOS et Android lorsque votre application n'utilise pas `OneSignal.Location`.
Définissez `ONESIGNAL_DISABLE_LOCATION=true` avant de résoudre ou de compiler les dépendances natives. La valeur n'est pas sensible à la casse. Vous pouvez aussi la définir sur `1`.
```shell Sync theme={null}
ONESIGNAL_DISABLE_LOCATION=true npx cap sync
```
```shell Run theme={null}
ONESIGNAL_DISABLE_LOCATION=true npx cap run ios
ONESIGNAL_DISABLE_LOCATION=true npx cap run android
```
```yaml GitHub Actions theme={null}
env:
ONESIGNAL_DISABLE_LOCATION: true
```
Lorsque le module de localisation est désactivé, les appels à `OneSignal.Location` sont ignorés sur Android. `OneSignal.Location.isShared()` se résout à `false`.
#### Appliquer le changement après la mise en cache des dépendances natives
La variable d'environnement est lue lorsque les dépendances natives sont résolues. Si vous modifiez la variable dans un projet existant, effacez le cache concerné et résolvez à nouveau dans un shell où la variable est exportée.
```shell Swift Package Manager theme={null}
rm -rf ~/Library/Caches/org.swift.swiftpm ~/Library/Developer/Xcode/DerivedData/*
ONESIGNAL_DISABLE_LOCATION=true npx cap sync ios
```
```shell CocoaPods theme={null}
cd ios/App
pod deintegrate
rm -rf Pods Podfile.lock
ONESIGNAL_DISABLE_LOCATION=true pod install
```
```shell Android Gradle theme={null}
ONESIGNAL_DISABLE_LOCATION=true npx cap sync android
cd android
ONESIGNAL_DISABLE_LOCATION=true ./gradlew assembleDebug
```
Lorsque vous utilisez Xcode ou Android Studio, lancez l'IDE depuis un terminal où `ONESIGNAL_DISABLE_LOCATION` est exportée. En CI, basez les clés de cache DerivedData, Swift Package Manager, CocoaPods et Gradle sur la valeur de `ONESIGNAL_DISABLE_LOCATION`.
### 2. Initialiser le SDK
Initialisez OneSignal au démarrage de votre application.
Remplacez `YOUR_APP_ID` par votre ID d'application OneSignal trouvé dans votre tableau de bord OneSignal **Paramètres > [Clés & IDs](./keys-and-ids)**.
Si vous n'avez pas accès à l'application OneSignal, demandez à vos [Membres de l'équipe](./manage-team-members) de vous inviter.
```typescript Angular theme={null}
import OneSignal, { LogLevel } from '@onesignal/capacitor-plugin';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
styleUrls: ['app.component.scss'],
})
export class AppComponent {
constructor() {
// Enable verbose logging for debugging (remove in production)
OneSignal.Debug.setLogLevel(LogLevel.Verbose);
// Initialize with your OneSignal App ID
OneSignal.initialize("YOUR_APP_ID");
// Use this method to prompt for push notifications.
// We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
OneSignal.Notifications.requestPermission(false).then((accepted: boolean) => {
console.log("User accepted notifications: " + accepted);
});
}
}
```
```typescript React theme={null}
import { useEffect } from 'react';
import OneSignal, { LogLevel } from '@onesignal/capacitor-plugin';
const App: React.FC = () => {
useEffect(() => {
// Enable verbose logging for debugging (remove in production)
OneSignal.Debug.setLogLevel(LogLevel.Verbose);
// Initialize with your OneSignal App ID
OneSignal.initialize("YOUR_APP_ID");
// Use this method to prompt for push notifications.
// We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
OneSignal.Notifications.requestPermission(false).then((accepted: boolean) => {
console.log("User accepted notifications: " + accepted);
});
}, []);
};
```
```typescript Vue theme={null}
import { createApp } from 'vue';
import App from './App.vue';
import router from './router';
import OneSignal, { LogLevel } from '@onesignal/capacitor-plugin';
import { IonicVue } from '@ionic/vue';
const app = createApp(App)
.use(IonicVue)
.use(router);
router.isReady().then(() => {
app.mount('#app');
// Enable verbose logging for debugging (remove in production)
OneSignal.Debug.setLogLevel(LogLevel.Verbose);
// Initialize with your OneSignal App ID
OneSignal.initialize("YOUR_APP_ID");
// Use this method to prompt for push notifications.
// We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
OneSignal.Notifications.requestPermission(false).then((accepted: boolean) => {
console.log("User accepted notifications: " + accepted);
});
});
```
Ouvrez votre fichier `capacitor.config.json` ou `capacitor.config.ts` et ajoutez le code suivant pour permettre à OneSignal de gérer les notifications push iOS.
Si l'abonnement échoue avec une erreur "APNS Delegate Never Fired", cette configuration résoudra le problème.
```json json theme={null}
{
"ios": {
"handleApplicationNotifications": false
}
}
```
```typescript capacitor.config.ts theme={null}
const config: CapacitorConfig = {
// ... additional configuration
ios: {
// ... additional configuration
handleApplicationNotifications: false
}
};
```
***
## Configuration Android
Assurez-vous que votre application OneSignal est configurée pour la plateforme Android en utilisant vos [identifiants Firebase](/docs/en/android-firebase-credentials).
Configurez vos [icônes de notification](/docs/en/notification-icons) pour qu'elles correspondent à l'image de marque de votre application. Si cette étape est ignorée, une icône de cloche par défaut s'affichera pour vos notifications push.
**Compiler pour Android**
À ce stade, vous devriez pouvoir compiler et exécuter votre application sur un appareil Android physique ou un émulateur sans problème.
Après avoir confirmé que votre compilation Android fonctionne :
* Continuez avec la [Configuration iOS](#ios-setup), le cas échéant.
* Ou passez directement à [Tester l'intégration du SDK OneSignal](#testing-the-onesignal-sdk-integration).
***
## Configuration iOS
Assurez-vous que votre application OneSignal est configurée pour la plateforme iOS en utilisant soit le [Jeton p8 (Recommandé)](/docs/en/ios-p8-token-based-connection-to-apns) ou le [Certificat p12](/docs/en/ios-p12-generate-certificates).
Suivez ces étapes pour ajouter les notifications push à votre application iOS, y compris la prise en charge des [Badges](/docs/en/badges), de la [Livraison confirmée](/docs/en/confirmed-delivery) et des images.
### 1. Ajouter la capacité Push Notifications à la cible de l'application
La [capacité Push Notifications](https://developer.apple.com/documentation/UserNotifications/registering-your-app-with-apns#Enable-the-push-notifications-capability) permet à votre application d'enregistrer un jeton push et de recevoir des notifications.
1. Ouvrez le fichier `.xcworkspace` de votre application dans Xcode.
2. Sélectionnez **votre cible d'application > Signing & Capabilities**
3. Cliquez sur **+ Capability** et ajoutez la capacité **Push Notifications**
### 2. Ajouter la capacité Background Modes à la cible de l'application
Cela permet à votre application de se réveiller en arrière-plan lorsque des notifications push arrivent.
1. Ajoutez la capacité [Background Modes](https://developer.apple.com/documentation/usernotifications/pushing-background-updates-to-your-app)
2. Activez **Remote notifications**
### 3. Ajouter la cible de l'application à un App Group
Les [App Groups](https://developer.apple.com/documentation/xcode/configuring-app-groups/#Create-App-Groups-for-all-other-platforms) permettent le partage de données entre votre application et le Notification Service Extension. Requis pour la Livraison confirmée et les Badges.
1. Ajoutez la capacité **App Groups**
2. Dans la capacité App Groups, cliquez sur **+**
3. Ajoutez un nouvel ID de conteneur au format : `group.your_bundle_id.onesignal`
* Conservez le préfixe **group.** et le suffixe **.onesignal**. Remplacez **`your_bundle_id`** par l'identifiant de bundle de votre application.
* Par exemple, l'identifiant de bundle `com.onesignal.MyApp` aura le nom de conteneur `group.com.onesignal.MyApp.onesignal`.
Le nom de votre App Group doit correspondre exactement à l'orthographe et à la casse de votre ID de bundle sur toutes les cibles.
1. Ouvrez le `Info.plist` de votre **App Target** et du **OneSignalNotificationServiceExtension Target**
2. Ajoutez une nouvelle propriété au `Info.plist` pour les deux cibles :
* **Clé :** `OneSignal_app_groups_key`
* **Valeur :** Le nom de votre App Group existant (par exemple, `group.your-custom-group-id`)
```xml XML theme={null}
OneSignal_app_groups_key
group.your-custom-group-id
```
Assurez-vous de mettre à jour le `OneSignal_app_groups_key` dans **à la fois** l'App Target **et** le `Info.plist` du OneSignalNotificationServiceExtension Target !
### 4. Ajouter le Notification Service Extension
Le [Notification Service Extension (NSE)](https://developer.apple.com/documentation/usernotifications/modifying-content-in-newly-delivered-notifications) permet les notifications enrichies et les analyses de Livraison confirmée.
1. Dans Xcode : **File > New > Target...**
2. Sélectionnez **Notification Service Extension**, puis **Next**.
3. Définissez le nom du produit sur `OneSignalNotificationServiceExtension` et appuyez sur **Finish**.
4. Appuyez sur **Don't Activate** sur l'invite Activate scheme.
Définissez le **Minimum Deployment Target** de OneSignalNotificationServiceExtension pour qu'il corresponde à votre application principale (iOS 15+ recommandé).
Si vous utilisez CocoaPods, définissez également la version de déploiement dans votre Podfile.
### 5. Ajouter la cible NSE à l'app group
Utilisez le même ID d'App Group que vous avez ajouté à l'étape 3.
1. Allez dans **OneSignalNotificationServiceExtension > Signing & Capabilities**
2. Ajoutez **App Groups**
3. Ajoutez exactement le même ID de groupe
Si vous utilisez un nom d'App Group personnalisé et non `group.your_bundle_id.onesignal`, assurez-vous d'ajouter votre ID d'App Group à la fois dans le `Info.plist` de l'App Target et du OneSignalNotificationServiceExtension Target ! Voir [l'étape 3](#3-add-app-target-to-app-group) pour plus d'informations.
### 6. Mettre à jour le code NSE
1. Naviguez vers le dossier **OneSignalNotificationServiceExtension**
2. Remplacez le contenu du fichier `NotificationService.swift` ou `NotificationService.m` par ce qui suit :
```swift Swift theme={null}
import UserNotifications
import OneSignalExtension
class NotificationService: UNNotificationServiceExtension {
var contentHandler: ((UNNotificationContent) -> Void)?
var receivedRequest: UNNotificationRequest!
var bestAttemptContent: UNMutableNotificationContent?
// Note this extension only runs when `mutable_content` is set
// Setting an attachment or action buttons automatically sets the property to true
override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
self.receivedRequest = request
self.contentHandler = contentHandler
self.bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
if let bestAttemptContent = bestAttemptContent {
// DEBUGGING: Uncomment the 2 lines below to check this extension is executing
// print("Running NotificationServiceExtension")
// bestAttemptContent.body = "[Modified] " + bestAttemptContent.body
OneSignalExtension.didReceiveNotificationExtensionRequest(self.receivedRequest, with: bestAttemptContent, withContentHandler: self.contentHandler)
}
}
override func serviceExtensionTimeWillExpire() {
// Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.
if let contentHandler = contentHandler, let bestAttemptContent = bestAttemptContent {
OneSignalExtension.serviceExtensionTimeWillExpireRequest(self.receivedRequest, with: self.bestAttemptContent)
contentHandler(bestAttemptContent)
}
}
}
```
```objectivec Objective-C theme={null}
#import
#import "NotificationService.h"
@interface NotificationService ()
@property (nonatomic, strong) void (^contentHandler)(UNNotificationContent *contentToDeliver);
@property (nonatomic, strong) UNNotificationRequest *receivedRequest;
@property (nonatomic, strong) UNMutableNotificationContent *bestAttemptContent;
@end
@implementation NotificationService
// Note, this extension only runs when mutable-content is set
// Setting an attachment or action buttons automatically adds this
- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
self.receivedRequest = request;
self.contentHandler = contentHandler;
self.bestAttemptContent = [request.content mutableCopy];
// DEBUGGING: Uncomment the 2 lines below and comment out the one above to ensure this extension is executing
// NSLog(@"Running NotificationServiceExtension");
// self.bestAttemptContent.body = [@"[Modified] " stringByAppendingString:self.bestAttemptContent.body];
[OneSignalExtension didReceiveNotificationExtensionRequest:self.receivedRequest
withMutableNotificationContent:self.bestAttemptContent
withContentHandler:self.contentHandler];
}
- (void)serviceExtensionTimeWillExpire {
// Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.
[OneSignalExtension serviceExtensionTimeWillExpireRequest:self.receivedRequest withMutableNotificationContent:self.bestAttemptContent];
self.contentHandler(self.bestAttemptContent);
}
@end
```
Vous devriez voir une erreur car le package OneSignal n'est pas installé. Cela sera résolu à l'étape suivante.
### 7. Ajouter OneSignal à la cible NSE
Si votre SDK utilise Swift Package Manager (SPM) pour les dépendances iOS, vous pouvez ignorer cette étape. Le package OneSignal est déjà résolu et disponible pour toutes les cibles.
Mettez à jour votre `ios/Podfile` pour inclure :
```ruby Podfile theme={null}
target 'OneSignalNotificationServiceExtension' do
pod 'OneSignalXCFramework', '>= 5.0.0', '< 6.0'
end
```
```ruby Example theme={null}
target 'MyApp' do
config = use_native_modules!
use_react_native!(
:path => config[:reactNativePath],
# An absolute path to your application root.
:app_path => "#{Pod::Config.instance.installation_root}/.."
)
post_install do |installer|
# https://github.com/facebook/react-native/blob/main/packages/react-native/scripts/react_native_pods.rb#L197-L202
react_native_post_install(
installer,
config[:reactNativePath],
:mac_catalyst_enabled => false,
# :ccache_enabled => true
)
end
end
target 'OneSignalNotificationServiceExtension' do
pod 'OneSignalXCFramework', '>= 5.0.0', '< 6.0'
end
```
Ouvrez votre projet dans le terminal et exécutez :
```shell shell theme={null}
cd ios pod install cd ..
```
#### Erreurs courantes de pod install
Vous pourriez rencontrer les erreurs suivantes, voici comment vous pouvez les résoudre.
CocoaPods s'appuie sur le gem Ruby `xcodeproj` pour lire vos fichiers de projet Xcode. À ce jour, la dernière version de `xcodeproj` ne reconnaît pas la version d'objet 70, qui a été introduite par Xcode 16. Ainsi, lorsque CocoaPods essaie d'ouvrir votre fichier `.xcodeproj`, il plante avec cette erreur.
1. Fermez Xcode.
2. Naviguez vers le fichier `ios/.xcodeproj/project.pbxproj` de votre projet.
3. Changez cette ligne : `objectVersion = 70;`
4. Remplacez-la par : `objectVersion = 55;`
5. Enregistrez, fermez et réexécutez `cd ios pod install cd ..`
### Compiler pour iOS
Vous devriez maintenant pouvoir compiler et exécuter votre application sur un appareil iOS réel ou un simulateur iOS (16.2+).
#### Erreurs courantes de compilation iOS
Vous pourriez voir cette erreur lors de la compilation avec Xcode 15+, en raison d'un changement de configuration par défaut affectant les systèmes multiplateformes.
1. Ouvrez votre dossier `.xcworkspace` dans Xcode et naviguez vers **votre cible d'application > Build Phases**.
2. Vous devriez avoir une phase appelée **"Embed Foundation Extensions"** ou **"Embed App Extensions"**.
3. Faites glisser et déplacez cette phase de compilation *au-dessus* de **"Run Script"**.
4. Compilez et exécutez votre application. L'erreur devrait être résolue.
RuntimeError - `PBXGroup` a tenté d'initialiser un objet avec un ISA inconnu `PBXFileSystemSynchronizedRootGroup` à partir des attributs : `{"isa"=>"...", "exceptions"=>["//", "..."], "explicitFileTypes"=>{}, "explicitFolders"=>[], "path"=>"OneSignalNotificationServiceExtension", "sourceTree"=>""}`
Correction :
1. Trouvez le dossier listé sous "path" dans l'erreur
2. Dans la barre latérale du projet Xcode, faites un clic droit sur le dossier
3. Sélectionnez **Convert to Group**
Après avoir confirmé que votre compilation iOS fonctionne, continuez avec [Tester l'intégration du SDK OneSignal](#testing-the-onesignal-sdk-integration).
***
## Tester l'intégration du SDK OneSignal
Ce guide vous aide à vérifier que votre intégration du SDK OneSignal fonctionne correctement en testant les notifications push, l'enregistrement des abonnements et la messagerie in-app.
Si vous testez avec un émulateur Android, il doit démarrer avec un démarrage à froid.
1. Allez dans **Device Manager** dans Android Studio.
2. Sélectionnez votre appareil émulateur et cliquez sur **Edit**.
3. Allez dans **Additional Settings** ou **More**.
4. Définissez l'**option de démarrage** sur **Cold Boot**.
5. Enregistrez les modifications et redémarrez l'émulateur.
### Vérifier les abonnements mobiles
L'invite d'autorisation push native devrait apparaître automatiquement si vous avez ajouté la méthode `requestPermission` lors de l'initialisation.
Avant d'accepter l'invite, vérifiez le tableau de bord OneSignal :
* Allez dans **Audience > Subscriptions**.
* Vous devriez voir une nouvelle entrée avec le statut "Never Subscribed".
Le statut de l'abonnement devrait maintenant afficher **Subscribed**.
Vous avez créé avec succès un [abonnement mobile](/docs/en/subscriptions).
Les abonnements mobiles sont créés lorsque les utilisateurs ouvrent votre application pour la première fois sur un appareil ou s'ils désinstallent et réinstallent votre application sur le même appareil.
### Configurer les abonnements de test
Les abonnements de test sont utiles pour tester une notification push avant d'envoyer un message.
Dans le tableau de bord, à côté de l'abonnement, cliquez sur le bouton **Options (trois points)** et sélectionnez **Add to Test Users**.
Nommez l'abonnement afin de pouvoir identifier facilement votre appareil plus tard dans l'**onglet Test Users**.
Allez dans **Audience > Segments > New Segment**.
Nommez le segment `Test Users` (le nom est important car il sera utilisé plus tard).
Vous avez créé avec succès un segment d'utilisateurs de test.
Nous pouvons maintenant tester l'envoi de messages à cet appareil individuel et à des groupes d'utilisateurs de test.
### Envoyer un push de test via l'API
Dans votre tableau de bord OneSignal, allez dans **Settings > [Keys & IDs](/docs/en/keys-and-ids)**.
Remplacez `YOUR_APP_API_KEY` et `YOUR_APP_ID` dans le code ci-dessous par vos clés réelles. Ce code utilise le segment `Test Users` que nous avons créé plus tôt.
```curl theme={null}
curl -X \
POST --url 'https://api.onesignal.com/notifications' \
--header 'content-type: application/json; charset=utf-8' \
--header 'authorization: Key YOUR_APP_API_KEY' \
--data \
'{
"app_id": "YOUR_APP_ID",
"target_channel": "push",
"name": "Testing basic setup",
"headings": {
"en": "👋"
},
"contents": {
"en": "Hello world!"
},
"included_segments": [
"Test Users"
],
"ios_attachments": {
"onesignal_logo": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
},
"big_picture": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'
```
Exécutez le code dans votre terminal.
Si toutes les étapes de configuration ont été complétées avec succès, les abonnements de test devraient recevoir une notification avec une image incluse :
Les images apparaîtront petites dans la vue de notification réduite. Développez la notification pour voir l'image complète.
Dans votre tableau de bord, allez dans **Delivery > Sent Messages**, puis cliquez sur le message pour afficher les statistiques.
Vous devriez voir la statistique **confirmed**, ce qui signifie que l'appareil a reçu la push.
Vous avez envoyé avec succès une notification via notre API à un segment.
* Aucune image reçue ? Votre [Notification Service Extension](#ios-setup) est peut-être manquant.
* Aucune livraison confirmée ? Consultez le guide de dépannage [ici](/docs/en/confirmed-delivery#troubleshooting-confirmed-delivery).
* Vous rencontrez des problèmes ? Copiez-collez la requête API et un journal du début à la fin du lancement de l'application dans un fichier `.txt`. Ensuite, partagez les deux avec `support@onesignal.com`.
### Envoyer un message in-app
Les [messages in-app](/docs/en/in-app-messages-setup) vous permettent de communiquer avec les utilisateurs pendant qu'ils utilisent votre application.
C'est parce que les utilisateurs doivent répondre aux critères d'audience in-app *avant* qu'une nouvelle session ne commence. Dans OneSignal, une nouvelle session commence lorsque l'utilisateur ouvre votre application après qu'elle ait été en arrière-plan ou fermée pendant au moins 30 secondes. Pour plus de détails, consultez notre guide sur [comment les messages in-app sont affichés](/docs/en/in-app-messages-setup#how-are-iams-displayed%3F).
* Dans votre tableau de bord OneSignal, naviguez vers **Messages > In-App > New In-App**.
* Trouvez et sélectionnez le message **Welcome**.
* Définissez votre Audience comme le segment **Test Users** que nous avons utilisé précédemment.
Sous **Schedule > How often do you want to show this message?** sélectionnez **Every time trigger conditions are satisfied**.
Cliquez sur **Make Message Live** pour qu'il soit disponible pour vos utilisateurs de test chaque fois qu'ils ouvrent l'application.
Après que le message in-app soit actif, ouvrez votre application. Vous devriez le voir s'afficher :
Vous ne voyez pas le message ?
* Démarrez une nouvelle session
* Vous devez fermer ou mettre l'application en arrière-plan pendant au moins 30 secondes avant de la rouvrir. Cela garantit qu'une nouvelle session est démarrée.
* Pour plus d'informations, voir [comment les messages in-app sont affichés](/docs/en/in-app-messages-setup#how-are-iams-displayed%3F).
* Toujours dans le segment `Test Users` ?
* Si vous avez réinstallé ou changé d'appareil, réajoutez l'appareil aux [abonnements de test](#set-up-test-subscriptions) et confirmez qu'il fait partie du segment Test Users.
* Vous rencontrez des problèmes ?
* Suivez [Obtenir un journal de débogage](/docs/en/capturing-a-debug-log) tout en reproduisant les étapes ci-dessus. Cela générera des journaux supplémentaires que vous pourrez partager avec `support@onesignal.com` et nous vous aiderons à enquêter sur ce qui se passe.
Vous avez configuré avec succès le SDK OneSignal et appris des concepts importants tels que :
* Collecter des [Abonnements](/docs/en/subscriptions), définir des [abonnements de test](/docs/en/find-set-test-subscriptions) et créer des [Segments](/docs/en/segmentation).
* Envoyer des [Push](/docs/en/push) avec des images et une [Livraison confirmée](/docs/en/confirmed-delivery) en utilisant des Segments et notre API [Create message](/reference/create-message).
* Envoyer des [messages in-app](/docs/en/in-app-messages-setup).
Continuez avec ce guide pour identifier les utilisateurs dans votre application et configurer des fonctionnalités supplémentaires.
***
## Identification des utilisateurs
Précédemment, nous avons démontré comment créer des [Abonnements](/docs/en/subscriptions) mobiles. Nous allons maintenant étendre l'identification des [Utilisateurs](/docs/en/users) sur tous leurs abonnements (y compris push, email et SMS) en utilisant le SDK OneSignal. Nous couvrirons les External IDs, les tags, les abonnements multicanaux, la confidentialité et le suivi des événements pour vous aider à unifier et engager les utilisateurs sur toutes les plateformes.
### Attribuer un External ID
Utilisez un External ID pour identifier les utilisateurs de manière cohérente sur tous les appareils, adresses e-mail et numéros de téléphone en utilisant l'identifiant utilisateur de votre backend. Cela garantit que votre messagerie reste unifiée sur tous les canaux et systèmes tiers (particulièrement important pour les [Intégrations](/docs/en/integrations)).
Définissez l'External ID avec la [méthode `login`](/docs/en/mobile-sdk-reference#login-external-id) de notre SDK chaque fois qu'ils sont identifiés par votre application.
OneSignal génère des ID uniques en lecture seule pour les abonnements (Subscription ID) et les utilisateurs (OneSignal ID).
Lorsque les utilisateurs téléchargent votre application sur différents appareils, s'abonnent à votre site Web et/ou vous fournissent des adresses e-mail et des numéros de téléphone en dehors de votre application, de nouveaux abonnements seront créés.
La définition de l'External ID via notre SDK est fortement recommandée pour identifier les utilisateurs sur tous leurs abonnements, quelle que soit la façon dont ils sont créés.
### Ajouter des tags de données
Les [Tags](/docs/en/add-user-data-tags) sont des paires clé-valeur de données chaîne que vous pouvez utiliser pour stocker les propriétés des utilisateurs (comme `username`, `role` ou les préférences) et les événements (comme `purchase_date`, `game_level` ou les interactions utilisateur). Les tags alimentent la [Personnalisation des messages](/docs/en/message-personalization) et la [Segmentation](/docs/en/segmentation) avancées permettant des cas d'utilisation plus avancés.
Définissez les tags avec les [méthodes `addTag` et `addTags`](/docs/en/mobile-sdk-reference#data-tags) de notre SDK au fur et à mesure que les événements se produisent dans votre application.
Dans cet exemple, l'utilisateur a atteint le niveau 6 identifiable par le tag appelé `current_level` défini sur une valeur de `6`.
Nous pouvons créer un segment d'utilisateurs ayant un niveau entre 5 et 10, et l'utiliser pour envoyer des messages ciblés et personnalisés :
### Ajouter des abonnements email et/ou SMS
Plus tôt, nous avons vu comment notre SDK crée des abonnements mobiles pour envoyer des messages push et in-app. Vous pouvez également atteindre les utilisateurs via les canaux email et SMS en créant les abonnements correspondants.
* Utilisez la [méthode `addEmail`](/docs/en/mobile-sdk-reference#addemail-%2C-removeemail) pour créer des abonnements email.
* Utilisez la [méthode `addSms`](/docs/en/mobile-sdk-reference#addsms-%2C-removesms) pour créer des abonnements SMS.
Si l'adresse e-mail et/ou le numéro de téléphone existent déjà dans l'application OneSignal, le SDK l'ajoutera à l'utilisateur existant, il ne créera pas de doublons.
Vous pouvez afficher les utilisateurs unifiés via **Audience > Users** dans le tableau de bord ou avec l'[API View user](/reference/view-user).
Meilleures pratiques pour la communication multicanale
* Obtenez un consentement explicite avant d'ajouter des abonnements email ou SMS.
* Expliquez les avantages de chaque canal de communication aux utilisateurs.
* Fournissez des préférences de canal afin que les utilisateurs puissent sélectionner les canaux qu'ils préfèrent.
***
### Confidentialité et consentement de l'utilisateur
Pour contrôler quand OneSignal collecte les données utilisateur, utilisez les méthodes de contrôle du consentement du SDK :
* [`setConsentRequired(true)`](/docs/en/mobile-sdk-reference#setconsentrequired) : Empêche la collecte de données jusqu'à ce que le consentement soit donné.
* [`setConsentGiven(true)`](/docs/en/mobile-sdk-reference#setconsentgiven) : Active la collecte de données une fois le consentement accordé.
Consultez nos documents sur la confidentialité et la sécurité pour en savoir plus sur :
* [Données collectées par le SDK](/docs/en/data-collected-by-the-onesignal-sdk)
* [Gestion des données personnelles](/docs/en/handling-personal-data)
***
## Demander les autorisations push
Au lieu d'appeler `requestPermission()` immédiatement à l'ouverture de l'application, adoptez une approche plus stratégique. Utilisez un message in-app pour expliquer la valeur des notifications push avant de demander l'autorisation.
Pour les meilleures pratiques et les détails d'implémentation, consultez notre guide [Demander les autorisations push](/docs/en/prompt-for-push-permissions).
***
## Écouter les événements push, utilisateur et in-app
Utilisez les écouteurs du SDK pour réagir aux actions des utilisateurs et aux changements d'état.
Le SDK fournit plusieurs écouteurs d'événements auxquels vous pouvez vous connecter. Consultez notre [guide de référence du SDK](/docs/en/mobile-sdk-reference) pour plus de détails.
### Événements de notification push
* [`addClickListener()`](/docs/en/mobile-sdk-reference#addclicklistener-push) : Détecter quand une notification est tapée. Utile pour les [Deep Linking](/docs/en/deep-linking).
* [`addForegroundLifecycleListener()`](/docs/en/mobile-sdk-reference#addforegroundlifecyclelistener-push) : Contrôler comment les notifications se comportent au premier plan.
Pour une personnalisation complète, consultez [Mobile Service Extensions](/docs/en/service-extensions).
### Changements d'état de l'utilisateur
* [`addObserver()` pour l'état utilisateur](/docs/en/mobile-sdk-reference#addobserver-user-state) : Détecter quand l'External ID est défini.
* [`addPermissionObserver()`](/docs/en/mobile-sdk-reference#addpermissionobserver-push) : Suivre l'interaction spécifique de l'utilisateur avec l'invite d'autorisation push native.
* [`addObserver()` pour l'abonnement push](/docs/en/mobile-sdk-reference#addobserver-push-subscription-changes) : Suivre quand le statut de l'abonnement push change.
### Événements de message in-app
* [`addClickListener()`](/docs/en/mobile-sdk-reference#addclicklistener-in-app) : Gérer les actions de clic in-app. Idéal pour le deep linking ou le suivi des événements.
* [`addLifecycleListener()`](/docs/en/mobile-sdk-reference#addclicklistener-in-app) : Suivre le cycle de vie complet des messages in-app (affiché, cliqué, rejeté, etc.).
***
## Configuration avancée et capacités
Explorez davantage de capacités pour améliorer votre intégration :
* [🔁 Migrer vers OneSignal depuis un autre service](/docs/en/migrating-to-onesignal)
* [🌍 Suivi de localisation](/docs/en/mobile-sdk-reference#location)
* [🔗 Deep Linking](/docs/en/deep-linking)
* [🔌 Intégrations](/docs/en/integrations)
* [🧩 Extensions de service mobile](/docs/en/service-extensions)
* [🛎️ Boutons d'action](/docs/en/action-buttons)
* [🌐 Messagerie multilingue](/docs/en/multi-language-messaging)
* [🛡️ Vérification d'identité](/docs/en/identity-verification)
* [📊 Résultats personnalisés](/docs/en/custom-outcomes)
* [📲 Live Activities](/docs/en/live-activities)
### Configuration et référence du SDK mobile
Assurez-vous d'avoir activé toutes les fonctionnalités clés en consultant le guide [Configuration push mobile](/docs/en/mobile-push-setup).
Pour tous les détails sur les méthodes disponibles et les options de configuration, visitez la [référence du SDK mobile](/docs/en/mobile-sdk-reference).
Félicitations ! Vous avez terminé avec succès le guide de configuration du SDK mobile.
***
Besoin d'aide ?
Discutez avec notre équipe d'assistance ou envoyez un e-mail à `support@onesignal.com`
Veuillez inclure :
* Les détails du problème que vous rencontrez et les étapes de reproduction si disponibles
* Votre OneSignal App ID
* L'External ID ou le Subscription ID le cas échéant
* L'URL du message que vous avez testé dans le OneSignal Dashboard le cas échéant
* Tous les [journaux ou messages d'erreur](/docs/en/capturing-a-debug-log) pertinents
Nous serons ravis de vous aider !
***