Vue d'ensemble

Les API de suppression de données de Rokt permettent à nos clients d'envoyer et de gérer des demandes de suppression de données des sujets vers notre plateforme. Ces API automatisent les processus relatifs aux données clients et à la réglementation sur la confidentialité, et les exécutent avec plus de confiance et moins de risque.

Rokt prend en charge les demandes de suppression de données pour des comptes spécifiques qui ont été autorisés par Rokt. Si votre compte n'a pas été autorisé et nécessite un accès à la suppression de données, veuillez contacter votre gestionnaire de compte Rokt.

Fonctionnalité

Les demandes de suppression de données sont actuellement mises en file d'attente pendant 15 jours avant d'être traitées par les systèmes internes de Rokt. Le cycle de vie d'une demande est décrit comme suit :

Les demandes de suppression sont :

• Créées via un appel API dans un état PENDING.
• Déplacées à l'état READY après 12 jours (~288 heures).
  • Une fois dans l'état READY, notre équipe OPS interne est alertée pour une révision manuelle supplémentaire si nécessaire.
• Transmises à nos systèmes internes après 3 jours (~72 heures) et traitées dans un délai maximal de 15 jours supplémentaires - portant la durée maximale du processus à 30 jours.
• Seules peuvent être annulées lorsqu'elles sont dans l'état PENDING ou READY via des appels API. Le statut passera à CANCELLED et pourra être récupéré dans toutes les tâches GET ultérieures.

Authentification

Les API de suppression de données de Rokt partagent le même mécanisme d'authentification mis en œuvre pour les API d'événements et de rapports, comme décrit dans nos instructions d'authentification.

Pour accéder aux API, vous avez besoin d'un AppId et du AppSecret associé. Ceux-ci peuvent être générés sur le tableau de bord Rokt comme décrit dans la documentation ci-dessus. Alternativement, vous pouvez contacter votre gestionnaire de compte pour vous aider à traverser le processus.

Structure de l'API

L'URL de base pour les API de suppression de données est : https://api.rokt.com

Les points de terminaison suivants sont actuellement disponibles :

Méthode	Point de terminaison	Objectif
POST	/data/deletion-requests/emails	Crée une nouvelle demande de suppression de données utilisateur. Les utilisateurs sont actuellement identifiés par adresse e-mail brute (liste), adresse e-mail hachée (SHA256) (liste).
GET	/data/deletion-requests	Renvoie une liste des demandes de suppression de données actuelles (PENDING, READY) et passées (ACTIONED, CANCELLED) pour vérifier leur statut.
DELETE	/data/deletion-requests/:task_id	Permet à un utilisateur de l'API d'annuler une demande de suppression de données qui est uniquement dans les états READY et PENDING.

Points de terminaison

Créer une demande

Point de terminaison	/data/deletion-requests/emails
Méthode	POST
Paramètres de requête	aucun

Exemple de demande :

{
  "accountId": "2456192011195196284677",
  "rawEmails": [
    "test@test.com"
  ],
  "sha256Emails": [
    "kJbnntuJYvQBhPiiHQcz6OSn0EyvzVeOBmtsG2sWkyU="
  ]
}

Exemple de réponse : Code Http 202

Remarques:

• Chaque demande de suppression peut contenir plusieurs entrées dans chacune des 3 listes : rawEmails, et sha256Emails.
• Au moins 1 entrée parmi les 3 listes doit être remplie pour que la demande soit valide.
• Les sha256Emails doivent être fournis en encodage base64.

GET demandes de suppression

Point de terminaison	/data/deletion-requests
Méthode	GET
Paramètres de requête	aucun
Exemple de demande	aucun

Exemple de réponse

[
    {
        "taskId": "20675afe-f4e5-4ee6-bfb7-d5fddcffe16d",
        "status": "actioned",
        "deletionType": "emailsDeletion",
        "creationTime": "2022-03-01T11:00:00+11:00",
        "accountId": "3008848650853038987",
        "readyTime": null,
        "actionedTime": null,
        "cancelledTime": null
    }
]

Annuler la demande de suppression

Endpoint	/data/deletion-requests/:taskId
Méthode	DELETE
Paramètres de requête	Dans l'URI - taskId : l'identifiant de la demande de suppression qui sera annulée
Exemple de requête	aucun

Exemple de réponse

{
  "data": {
    "message": "tâche annulée avec succès avec taskId : 3bc2e8b0-88ee-400c-8696-44897bc95cd3"
  }
}  

Gestion des erreurs

Toutes les API suivent les codes de réponse d'erreur RESTful les plus courants : 400, 403, 404, 500, etc.

Toute erreur est signalée à l'appelant dans le format JSON suivant :

{
  "error": {
    "code": 404,
    "error": "NOT_FOUND",
    "message": "tâche non trouvée pour task_id :..."
  }
}

Les codes d'erreur suivants sont actuellement pris en charge :

Code HTTP	Erreur	Explication
400	BAD_REQUEST	La requête est mal formée ou incomplète
500	INTERNAL_SERVER_ERROR	Erreur interne du serveur
403	AUTHENTICATION_ERROR	Impossible d'authentifier la requête
403	UNAUTHORIZED_ACCOUNT	Le compte utilisé n'est actuellement pas autorisé pour les demandes de suppression de données
404	NOT_FOUND	Ressource non trouvée
410	DEADLINE_EXCEEDED	La demande de suppression ne peut pas être annulée car elle a dépassé ses états PENDING et READY