> ## 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.

# Application d'exemple : une intégration OneSignal complète

> Suivez une application réelle, Clean Beans, pour voir comment push, in-app, e-mail, SMS, Live Activities et Event Streams s'articulent dans Expo avec Supabase.

La plupart des guides OneSignal expliquent une fonctionnalité à la fois. Celui-ci suit une seule application de bout en bout et montre comment chaque fonctionnalité de messagerie a été intégrée, avec le code qui tourne en production.

L'application s'appelle **Clean Beans**, un planning de ménage pour les logements partagés. Elle est construite avec Expo (React Native) et utilise Supabase pour sa base de données, son authentification et ses fonctions backend. OneSignal gère tous les messages envoyés par l'application.

![Trois écrans de Clean Beans : le tableau de bord, une session de ménage et le planning hebdomadaire](https://mintcdn.com/onesignal/XdN288-p34EfpfHk/images/tutorials/cleanbeans-dashboard-session-rota.png?fit=max\&auto=format\&n=XdN288-p34EfpfHk\&q=85\&s=f8fc7eac8e69faea6aece66f73c2d820)

Clean Beans : le tableau de bord, une session de ménage et le planning hebdomadaire.

## Ce que fait Clean Beans \\

Un foyer ajoute ses pièces, et l'application les transforme en une liste de tâches de ménage avec des fréquences raisonnables. Un générateur de planning répartit ces tâches sur la semaine en fonction du temps dont dispose chaque personne. Les membres lancent des sessions de ménage, cochent des tâches, enchaînent des séries quotidiennes, s'envoient des kudos et s'affrontent dans un classement hebdomadaire.

Le ménage est partagé, récurrent et soumis à des échéances, ce qui le rend adapté à presque tous les types de messages : rappels, actualités sociales, comptes à rebours, récapitulatifs et accompagnement.

## Pourquoi ce guide existe \\

Utilisez-le pour répondre à trois questions :

* **Quelle fonctionnalité OneSignal convient à quelle tâche ?** Chaque page part de quelque chose que l'application devait faire, puis montre la fonctionnalité qui le fait.
* **Où va le code ?** Une partie du travail revient à l'application, une partie à votre backend et une partie au tableau de bord OneSignal. Chaque exemple précise laquelle.
* **Qu'est-ce qui peut mal tourner ?** Les avertissements et notes de chaque page consignent ce qui a été appris en la mettant en production. Un paramètre, `collapse_id`, a été essayé puis retiré, et [Push fiable et bien maîtrisé](https://documentation.onesignal.com/docs/fr/example-full-integration-reliable-push.md) explique pourquoi.

## Comment le lire \\

Le guide est un ensemble de pages, une par sujet. Vous n'avez pas besoin de les lire dans l'ordre. [Configuration du SDK et identité utilisateur](https://documentation.onesignal.com/docs/fr/example-full-integration-sdk-setup.md) est la base de tout le reste. Ensuite, chaque page est autonome.

La plupart des fonctionnalités sont présentées de la même manière :

1. **Ce que voit l'utilisateur**, généralement avec une capture d'écran.
2. **Comment ça fonctionne**, sous forme d'une courte séquence indiquant qui fait quoi.
3. **Le code**, tiré de l'application. Le titre de chaque bloc de code est le fichier dont il provient.
4. **Configuration du tableau de bord**, lorsque la fonctionnalité doit être configurée dans OneSignal.

Les limites et les surprises sont signalées dans des avertissements et des notes à côté de la fonctionnalité concernée.

> [!NOTE]
>
> Le code est réel, mais les identifiants sont remplacés par des valeurs fictives comme `YOUR_ONESIGNAL_APP_ID` et `YOUR_PROJECT_REF`. Les fichiers longs sont réduits aux lignes importantes. Une ligne contenant uniquement `// ...` indique où du code a été omis.

## Comment les éléments s'articulent \\

| Où | Ce dont il est responsable | Exemples |
| - | - | - |
| **L'application Expo** | Tout ce qui nécessite l'appareil ou l'utilisateur connecté | Initialiser le SDK, demander l'autorisation, identifier l'utilisateur, tags, événements personnalisés, déclencheurs de messages in-app, gestion des appuis |
| **Le backend Supabase** | Tout ce qui est déclenché par une planification ou par un changement de données | Rappels, push sociaux, l'e-mail hebdomadaire, codes SMS et invitations, démarrage des Live Activities, réception des webhooks Event Stream |
| **Le tableau de bord OneSignal** | Le contenu et le ciblage qui doivent pouvoir changer sans nouvelle version | Messages in-app, le modèle d'e-mail, segments, Conversion Metrics, l'Event Stream |

L'**External ID** relie les trois. Clean Beans le définit sur l'ID utilisateur Supabase à la connexion, afin que le backend puisse s'adresser à n'importe qui à l'aide d'un ID qu'il stocke déjà.

![Schéma d'architecture montrant l'application Expo, le backend Supabase et le tableau de bord OneSignal](https://mintcdn.com/onesignal/XdN288-p34EfpfHk/images/tutorials/clean-beans-architecture.png?fit=max\&auto=format\&n=XdN288-p34EfpfHk\&q=85\&s=b6d5655991cdf5b4de0645b9d7f9cd95)

L'application, le backend et le tableau de bord communiquent chacun avec OneSignal. L'External ID les rattache à un même utilisateur.

## Carte des fonctionnalités \\

| Ce dont l'application avait besoin | Fonctionnalité OneSignal | Page |
| - | - | - |
| Savoir à qui appartient chaque appareil | External ID, abonnement e-mail | [Configuration du SDK et identité utilisateur](https://documentation.onesignal.com/docs/fr/example-full-integration-sdk-setup.md) |
| Personnaliser et segmenter | Tags, événements personnalisés, Conversion Metrics | [Tags, événements personnalisés et Conversion Metrics](https://documentation.onesignal.com/docs/fr/example-full-integration-tags-events.md) |
| Rappeler les tâches aux utilisateurs | API Create message depuis des fonctions planifiées | [Envoyer des push depuis votre backend](https://documentation.onesignal.com/docs/fr/example-full-integration-backend-push.md) |
| Informer les colocataires de ce qui s'est passé | API Create message depuis des événements de l'application et de la base de données | [Envoyer des push depuis votre backend](https://documentation.onesignal.com/docs/fr/example-full-integration-backend-push.md) |
| Ne jamais envoyer un rappel deux fois | Clés d'idempotence | [Push fiable et bien maîtrisé](https://documentation.onesignal.com/docs/fr/example-full-integration-reliable-push.md) |
| Adapter le comportement de chaque push | Expiration, regroupement, niveaux d'interruption, badges | [Push fiable et bien maîtrisé](https://documentation.onesignal.com/docs/fr/example-full-integration-reliable-push.md) |
| Ouvrir le bon écran depuis un appui ou un lien | Écouteur de clic, deep links, Universal Links | [Deep links et clics sur les notifications](https://documentation.onesignal.com/docs/fr/example-full-integration-deep-links.md) |
| Permettre d'agir directement depuis une notification | Boutons d'action, envoi planifié | [Deep links et clics sur les notifications](https://documentation.onesignal.com/docs/fr/example-full-integration-deep-links.md) |
| Accompagner et guider les utilisateurs dans l'application | Messages in-app avec déclencheurs et HTML personnalisé | [Messages in-app](https://documentation.onesignal.com/docs/fr/example-full-integration-in-app-messages.md) |
| Envoyer un récapitulatif hebdomadaire | Modèle d'e-mail avec `custom_data` | [E-mail hebdomadaire avec custom\_data](https://documentation.onesignal.com/docs/fr/example-full-integration-weekly-email.md) |
| Prouver qu'un numéro de téléphone appartient à l'utilisateur | SMS vers un numéro brut, abonnement SMS | [SMS : codes de vérification et invitations](https://documentation.onesignal.com/docs/fr/example-full-integration-sms.md) |
| Inviter des personnes qui n'ont pas l'application | SMS et e-mail vers des contacts bruts | [SMS : codes de vérification et invitations](https://documentation.onesignal.com/docs/fr/example-full-integration-sms.md) |
| Afficher un compte à rebours sur l'écran de verrouillage | Live Activities | [Live Activities](https://documentation.onesignal.com/docs/fr/example-full-integration-live-activities.md) |
| Conserver un historique des notifications dans l'application | Event Streams | [Boîte de réception des notifications avec Event Streams](https://documentation.onesignal.com/docs/fr/example-full-integration-inbox.md) |
| Garder les paramètres de l'application en phase avec les désabonnements | Event Streams (événements e-mail) | [Boîte de réception des notifications avec Event Streams](https://documentation.onesignal.com/docs/fr/example-full-integration-inbox.md) |

## Ce dont vous avez besoin \\

* Une application OneSignal avec le push configuré pour iOS et Android, ainsi que l'e-mail et le SMS. Consultez [Configuration des canaux](https://documentation.onesignal.com/docs/fr/channel-setup.md).
* Une application Expo compilée avec EAS Build. Le SDK OneSignal nécessite du code natif, Expo Go ne suffit donc pas. Consultez [Configuration du SDK Expo](https://documentation.onesignal.com/docs/fr/react-native-expo-sdk-setup.md).
* Votre App ID et une App API key. Consultez [Clés et ID](https://documentation.onesignal.com/docs/fr/keys-and-ids.md).
* Un backend capable d'exécuter du code selon une planification et en réponse à des requêtes. Clean Beans utilise Supabase Edge Functions avec `pg_cron`. Les mêmes principes s'appliquent à n'importe quel backend.

## Principes qui ont fait leurs preuves \\

* **Définissez d'abord l'External ID.** Presque toutes les fonctionnalités présentées ici en dépendent. Utilisez un ID que votre backend stocke déjà.
* **Placez chaque tâche au bon endroit.** L'application gère l'appareil et l'utilisateur connecté. Le backend gère les planifications et les changements de données. Le tableau de bord contient tout ce que vous voulez modifier sans nouvelle version.
* **Vérifiez avant d'envoyer.** Chaque envoi du backend vérifie les préférences de l'utilisateur et confirme qu'il y a quelque chose d'utile à dire.
* **Rendez les envois planifiés rejouables.** Une clé d'idempotence construite à partir du type, du destinataire et de la date transforme une nouvelle tentative en opération sans effet.
* **Routez selon un type, pas une URL.** Un champ `data.type` permet aux anciennes notifications de continuer à fonctionner lorsque les écrans changent.
* **Vérifiez ce que vous disent les appelants.** Une fonction qui envoie des messages doit d'abord confirmer les faits dans votre propre base de données.

## Toutes les fonctionnalités en un coup d'œil \\

| Fonctionnalité | Canal | Déclencheur | S'exécute dans | Fichier principal |
| - | - | - | - | - |
| Initialisation du SDK et autorisation | Push | Lancement de l'application | Application | `app/_layout.tsx` |
| Identité utilisateur | Tous | Connexion et déconnexion | Application | `app/_layout.tsx` |
| Abonnement e-mail | E-mail | Connexion | Application | `src/lib/onesignalSync.ts` |
| Opt-in et préférences | Push, e-mail | Écran des paramètres | Application et base de données | `app/notification-settings.tsx` |
| Tags | Tous | Connexion, session, modification du profil | Application | `src/lib/onesignalSync.ts` |
| Événements personnalisés | Tous | Début et fin de session | Application | `src/lib/onesignalSync.ts` |
| Conversion Metrics | Tous | Fin de session | Tableau de bord | |
| Résumé quotidien | Push | Planification horaire | Backend | `supabase/functions/send-daily-digest/` |
| Rappel de tâches en retard | Push | Planification horaire | Backend | `supabase/functions/send-overdue-reminders/` |
| Rappel de ménage | Push | Planification horaire | Backend | `supabase/functions/send-cleaning-reminder/` |
| Session terminée | Push | Appel depuis l'application | Backend | `supabase/functions/session-completed/` |
| Kudos | Push | Appel depuis l'application | Backend | `supabase/functions/send-kudos/` |
| Adhésion approuvée | Push | Déclencheur de base de données | Backend | `supabase/functions/join-approved/` |
| Envois idempotents | Push, e-mail | Chaque envoi planifié | Backend | `supabase/functions/_shared/idempotency.ts` |
| Profils de livraison | Push | Chaque push | Backend | `supabase/functions/_shared/delivery.ts` |
| Badges | Push | Push de tâches | Backend | `supabase/functions/send-daily-digest/` |
| Routage des appuis | Push | Appui sur un push | Application | `app/_layout.tsx` |
| Boutons d'action | Push | Appui sur un bouton de push | Backend et application | `supabase/functions/_shared/buttons.ts`, `src/lib/pushActions.ts` |
| Rappel reporté | Push | Bouton de report | Backend | `supabase/functions/snooze-reminder/` |
| Réécriture des liens | Liens | Application ouverte depuis une URL | Application | `app/+native-intent.tsx` |
| Universal Links et App Links | Liens | Appui sur un lien web | Application et site web | `app.json`, `website/.well-known/` |
| Superpositions d'aide et visites guidées | In-app | Bouton d'aide | Application et tableau de bord | `src/components/HelpButton.tsx` |
| Pré-invite d'autorisation push | In-app | Audience du tableau de bord | Tableau de bord | `docs/iam-html/push-permission-prompt.html` |
| Invite de mise à jour de l'application | In-app | Ancienne version de l'application | Tableau de bord | `docs/iam-html/app-update-prompt.html` |
| Demande d'avis | In-app | Palier de série | Application et tableau de bord | `src/lib/reviewPrompt.ts` |
| Rapport hebdomadaire | E-mail | Planification hebdomadaire | Backend et tableau de bord | `supabase/functions/weekly-report/` |
| Abonnement SMS | SMS | Numéro de téléphone vérifié, connexion | Application | `src/lib/phone.ts` |
| Code de vérification du téléphone | SMS | Appel depuis l'application | Backend | `supabase/functions/send-otp/`, `supabase/functions/verify-otp/` |
| Invitation au foyer | SMS, e-mail | Appel depuis l'application | Backend | `supabase/functions/send-invite/` |
| Alerte de série | Live Activity | Planification horaire | Backend et widget | `supabase/functions/streak-warning/` |
| Rappel de ménage | Live Activity | Planification horaire | Backend et widget | `supabase/functions/cleaning-activity/` |
| Boîte de réception des notifications | Event Streams | Chaque push envoyé ou cliqué | Backend et application | `supabase/functions/inbox-webhook/` |
| Synchronisation des préférences e-mail | Event Streams | E-mail désabonné, rejeté ou signalé comme spam | Backend | `supabase/functions/inbox-webhook/` |

## Secrets \\

Les fonctions backend les lisent depuis leur environnement. Aucun d'eux n'est jamais livré dans l'application.

```bash theme={null}
supabase secrets set ONESIGNAL_APP_ID=YOUR_ONESIGNAL_APP_ID
supabase secrets set ONESIGNAL_REST_API_KEY=YOUR_APP_API_KEY
supabase secrets set ONESIGNAL_WEEKLY_TEMPLATE_ID=YOUR_EMAIL_TEMPLATE_ID
supabase secrets set INBOX_WEBHOOK_SECRET=YOUR_SHARED_SECRET
supabase secrets set OTP_HASH_SECRET=A_LONG_RANDOM_STRING    # key for hashing SMS verification codes

# Optional
supabase secrets set ONESIGNAL_SMS_FROM=YOUR_SMS_SENDER      # if no default sender is set in the dashboard
```

> [!WARNING]
>
> Votre App API key peut envoyer des messages à tous les utilisateurs. Conservez-la sur votre backend. L'application n'a besoin que de l'App ID.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.