API de Désinscription Nurture
Objectif
L'API de Désinscription Nurture permet aux annonceurs et partenaires d'envoyer immédiatement les clients désinscrits au système Rokt pour une suppression en temps réel de toutes les communications des annonceurs. De plus, l'API de Désinscription Nurture peut être utilisée par Rokt pour envoyer des désinscriptions aux annonceurs.
Quels sont les avantages ?
- Efficacité. Assurez-vous que votre liste d'emails est mise à jour en temps réel.
- Précision. Maintenez une liste à jour pour garantir que seuls les clients qui restent inscrits reçoivent vos communications par email.
Pour qui l'API d'Importation de Désinscription Nurture est-elle adaptée ?
- Les annonceurs hébergeant leur propre page de désinscription (au lieu d'une page de destination propulsée par Rokt).
- Les annonceurs envoyant simultanément leurs propres communications par email en parallèle des séries de nurturing par email propulsées par Rokt à des clients générés par Rokt.
Ça a l'air 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 le travail d'ingénierie terminé ?
Une fois que l'API de désabonnement de nurturing (Nurture Unsubscribe API) est mise en place, vous êtes prêt. Chaque fois qu'un client se désabonne des nurtures par email de Rokt ou des communications des annonceurs, les deux systèmes sont mis à jour en temps réel.
Comment puis-je savoir que cela fonctionne ?
Les clients désabonnés peuvent être consultés dans One Platform. Cliquez sur votre compte depuis la page d'accueil, puis allez à la page Campagnes > Données client dans le menu de navigation à gauche et cliquez sur l'onglet Désabonnements.
Autorisation
L'API attend un en-tête d'autorisation dans le cadre de la requête. Cela garantit 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.
Obtention d'une clé API
- Allez sur OP1 - Données pour 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 comme vous traiteriez d'autres identifiants (comme un mot de passe).
Point de terminaison 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 map. Étant donné que la charge utile est en JSON, vous devez définir l'en-tête Content-Type sur application/json.
Gestion des réponses
| Statut HTTP | Description |
|---|---|
| 201 | L'email 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 le désabonnement ne soit traité. 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'a pas de signification particulière pour vous mais peut être utile pour aider à résoudre les problèmes si des problèmes surviennent, vous pouvez donc vouloir écrire la valeur dans les journaux de votre système. |
| 400 | Vous recevez un 400 Bad Request s'il manque des champs obligatoires ou si votre requête est dans un format incorrect. |
Étant donné que la réponse attendue de l'API est une charge utile JSON, votre requête doit inclure un en-tête "accept" de soit / ou application/json.
Paramètres
La clé suivante doit être présente dans la map :
| Paramètre | Description |
|---|---|
| Une seule adresse email (format brut) |
Exemples de ligne de commande
Sur un système Linux ou MacOS X avec la commande curl installée, la commande suivante désabonnera l'adresse email alice@example.com, en supposant que la variable d'environnement API_KEY est définie sur 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"}'
Tester l'API
Notez que les exemples ci-dessus pointent vers notre système de production en direct. Donc, si vous testez avec des adresses email comme alice@example.com, ces adresses ne recevront plus d'emails de nurturing. Ne testez pas avec des adresses email que vous ne souhaitez pas désabonner.