Nurture Unsubscribe API
Objectif
L'API de désabonnement Nurture permet aux annonceurs et aux partenaires d'envoyer immédiatement les clients désabonnés vers le système Rokt pour une suppression en temps réel de toutes les communications des annonceurs. De plus, l'API de désabonnement Nurture peut être utilisée par Rokt pour envoyer des désabonnements aux annonceurs.
Quels sont les avantages ?
- Efficacité. Assurez-vous que votre liste d'adresses e-mail est mise à jour en temps réel.
- Précision. Maintenez une liste à jour pour vous assurer que seuls les clients qui ont choisi de rester abonnés reçoivent vos communications par e-mail.
Pour qui l'API de désabonnement de l'importation de nurturing est-elle adaptée ?
- Les annonceurs qui hébergent leur propre page de désabonnement (au lieu d'une page d'atterrissage alimentée par Rokt).
- Les annonceurs qui envoient simultanément leurs propres communications par e-mail en parallèle avec les séries de nurturing par e-mail alimentées par Rokt aux clients générés par Rokt.
Cela semble génial. Que dois-je faire ?
Mobilisez vos ressources d'ingénierie pour mettre en place l'API. Contactez votre gestionnaire de compte pour obtenir la documentation sur la configuration de l'API. Pour ceux qui traitent de gros volumes et pour qui les listes de nurturing sont une priorité, cela vaut l'investissement initial en temps.
Comment cela fonctionne-t-il une fois que le travail d'ingénierie est terminé?
Une fois que l'API de désabonnement de Nurture a été configurée, vous êtes prêt. Chaque fois qu'un client se désabonne des e-mails de Rokt ou des communications publicitaires, les deux systèmes sont mis à jour en temps réel.
Comment savoir si cela fonctionne?
Les clients désabonnés peuvent être consultés dans One Platform. Cliquez sur votre compte depuis la page d'accueil, puis accédez à la page Campagnes > Données clients dans le menu de navigation de gauche et cliquez sur l'onglet Désabonnements.
Autorisation
L'API attend un en-tête d'autorisation dans la requête. Cela permet de vérifier que vous avez la permission d'accéder à la plateforme Rokt. La valeur de l'en-tête d'autorisation doit être la clé API unique de votre compte, agissant comme vos identifiants pour accéder à l'API Rokt.
Obtenir une clé API
- Accédez à OP1 - Données de votre compte.
- Cliquez sur Paramètres dans la navigation de gauche.
- Cliquez sur Clé API Webhook dans le sous-menu sous Paramètres.
- Si votre compte possède déjà une clé API, vous la verrez sur la page. Sinon, cliquez sur Créer une clé API pour en générer une.
Note de sécurité
Étant donné que cette clé API permet d'accéder aux API qui affectent votre compte Rokt, vous devez traiter cette clé API de la même manière que vous traiteriez d'autres identifiants (comme un mot de passe).
Point de terminaison de l'API
| URL du point de terminaison | https://api.data.rokt.com/1.0/nurture/unsubscribe |
|---|
L'API accepte une charge utile JSON qui doit être une carte. Comme la charge utile est JSON, vous devez définir l'en-tête Content-Type sur application/json.
Gestion de la réponse
| Statut HTTP | Description |
|---|---|
| 201 | L'e-mail a été reçu et le client sera désabonné. L'API renvoie immédiatement, mais il peut y avoir un certain délai avant que la désinscription ne soit traitée. Le corps de la réponse est une charge utile JSON contenant uniquement un ID, tel que {"id":"de445c4c-ec46-4e86-a945-ca65d59fda32"}.Cet ID n'est pas particulièrement significatif pour vous, mais peut être utile pour résoudre les problèmes éventuels, vous voudrez donc écrire la valeur dans les journaux de votre système. |
| 400 | Vous recevez une 400 Bad Request s'il manque des champs obligatoires ou si votre demande est au mauvais format. |
Étant donné que la réponse attendue de l'API est une charge utile JSON, votre demande doit inclure un en-tête "accept" de / ou application/json.
Paramètres
La clé suivante doit être présente dans la map:
| Paramètre | Description |
|---|---|
| Une seule adresse e-mail (format brut) |
Exemples de ligne de commande
Sur un système Linux ou MacOS X avec la commande curl installée, la commande suivante permettra de désinscrire l'adresse e-mail alice@example.com, en supposant que la variable d'environnement API_KEY soit définie avec votre clé API:
cURL
curl https://api.data.rokt.com/1.0/nurture/unsubscribe --header "Authorization: $API_KEY" --header "Content-Type: application/json" --data '{"email":"alice@example.com"}'
Test de l'API
Notez que les exemples ci-dessus pointent vers notre système de production en direct. Donc, si vous testez avec des adresses e-mail comme alice@example.com, ces adresses ne recevront plus d'e-mails de suivi. Ne testez pas avec des adresses e-mail auxquelles vous ne souhaitez pas vous désabonner.