Aller au contenu principal

API de suppression de données

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 de sujets à 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 l'accès à la suppression de données, veuillez contacter votre gestionnaire de compte Rokt.

FonctionnalitéLien direct vers 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 :

Cycle de l'API de suppression de données

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 un examen manuel supplémentaire si nécessaire.
  • Transmises à nos systèmes internes après 3 jours (~72 heures) et traitées dans un délai maximum 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 changera en CANCELLED et pourra être récupéré dans toutes les tâches GET ultérieures.

AuthentificationLien direct vers Authentification

Les API de suppression de données de Rokt partagent le même mécanisme d'authentification mis en œuvre pour l'API de reporting comme décrit ici.

Structure de l'APILien direct vers 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éthodePoint de terminaisonObjectif
POST/data/deletion-requests/emailsCrée une nouvelle demande de suppression de données utilisateur. Les utilisateurs sont actuellement identifiés par adresse e-mail brute (liste de), adresse e-mail hachée (SHA256) (liste de).
GET/data/deletion-requestsRetourne 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_idPermet à 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 terminaisonLien direct vers Points de terminaison

Créer une demandeLien direct vers Créer une demande

Point de terminaison/data/deletion-requests/emails
MéthodePOST
Paramètres de requêteaucun
Exemple de requête:Lien direct vers Exemple de requête:
{
"accountId": "2456192011195196284677",
"rawEmails": [
"test@test.com"
],
"sha256Emails": [
"kJbnntuJYvQBhPiiHQcz6OSn0EyvzVeOBmtsG2sWkyU="
]
}
Exemple de réponse: Http Code 202Lien direct vers example-response-http-code-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.
  • sha256Emails doit être fourni en encodage base64.

GET demandes de suppressionLien direct vers GET demandes de suppression

Point de terminaison/data/deletion-requests
MéthodeGET
Paramètres de requêteaucun
Exemple de requêteaucun
Exemple de réponseLien direct vers 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 suppressionLien direct vers Annuler la demande de suppression

Point de terminaison/data/deletion-requests/:taskId
MéthodeDELETE
Paramètres de requêteDans l'URI - taskId : l'identifiant de la demande de suppression qui sera annulée
Exemple de requêteaucun
Exemple de réponseLien direct vers Exemple de réponse
{
"data": {
"message": "successful cancelled task with taskId: 3bc2e8b0-88ee-400c-8696-44897bc95cd3"
}
}

Gestion des erreursLien direct vers 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": "task not found for with task_id:..."
}
}

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

Code HTTPErreurExplication
400BAD_REQUESTLa requête est mal formée ou incomplète
500INTERNAL_SERVER_ERRORErreur interne du serveur
403AUTHENTICATION_ERRORImpossible d'authentifier la requête
403UNAUTHORIZED_ACCOUNTLe compte utilisé n'est actuellement pas autorisé pour les demandes de suppression de données
404NOT_FOUNDRessource non trouvée
410DEADLINE_EXCEEDEDLa demande de suppression ne peut pas être annulée car elle a dépassé ses états PENDING et READY
Cet article vous a-t-il été utile ?