Demandes de confidentialité

Audience

Cette interface API est destinée aux partenaires d'intégration construisant sur le réseau Rokt. Les partenaires e-commerce de Rokt intégrant des emplacements sur leur propre processus de paiement devraient utiliser les documents développeurs Rokt Ecommerce à la place.

L'API Partnerships expose deux surfaces de demande de confidentialité. Elles sont séparées car elles agissent sur des sujets différents et utilisent différents systèmes en aval.

Cas d'utilisation	Point de terminaison	Sujet	Idempotence
Désinscription du réseau ou suppression des données du réseau	POST /v1/partnership/network-privacy-requests	Un utilisateur final du réseau Rokt, identifié par email, téléphone ou email haché	Pas de Idempotency-Key; réessayer uniquement après un backoff
Suppression des données au niveau du compte	POST /v1/partnership/accounts/{account_id}/data-deletion-requests	Un compte marchand géré appartenant à votre compte parent	Nécessite Idempotency-Key; sûr de réessayer avec la même clé

Choisissez la surface par sujet

Utilisez network-privacy-requests pour un consommateur demandant à se désinscrire des annonces Rokt ou à supprimer les données du réseau Rokt liées à leur identifiant. Utilisez accounts/{account_id}/data-deletion-requests pour supprimer les données liées à un compte marchand que votre plateforme gère.

Demandes de confidentialité du réseau

Soumettez des demandes de désinscription du réseau et de suppression des données du réseau avec votre jeton API et l'ID de votre compte parent :

curl -X POST "https://accounts.rokt.com/v1/partnership/network-privacy-requests?parent_account_id=$PARENT_ACCOUNT_ID" \
  -H "Authorization: Bearer $ROKT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "requestType": "NETWORK_OPT_OUT",
    "email": "consumer@example.com"
  }'

Le point de terminaison renvoie 202 Accepted après que Rokt a soumis la demande en aval. Il ne crée pas d'opération de partenariat et ne renvoie pas l'enveloppe de réponse standard.

X-Network-Privacy-Request-Iduuid

ID de demande de confidentialité généré par Rokt pour la corrélation de support et d'audit.

request_iduuid

Même ID de demande dans le corps de la réponse.

statusstring

État actuel du cycle de vie. Aujourd'hui, l'état soumis est submitted.

Règles d'identification

requestType	Identifiants acceptés	Identifiants rejetés	Action en aval
NETWORK_OPT_OUT	Exactement un de email ou phone	sha256Email; envoi de email et phone	Soumet un OPT_OUT au service de confidentialité/consentement de Rokt
NETWORK_DATA_DELETION	Exactement un de email ou sha256Email	phone; envoi de email et sha256Email	Envoie la même action de suppression de réseau que Rokt utilise pour les données utilisateur supprimées du réseau

sha256Email doit être un condensé SHA256 encodé en base64, pas une chaîne hexadécimale.

curl -X POST "https://accounts.rokt.com/v1/partnership/network-privacy-requests?parent_account_id=$PARENT_ACCOUNT_ID" \
  -H "Authorization: Bearer $ROKT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "requestType": "NETWORK_DATA_DELETION",
    "sha256Email": "kJbnntuJYvQBhPiiHQcz6OSn0EyvzVeOBmtsG2sWkyU="
  }'

Si un consommateur demande à la fois la suppression et la désinscription pour le même email, une seule soumission de suppression de réseau suffit. Rokt considère les données utilisateur supprimées du réseau comme supprimées de l'éligibilité aux futures annonces.

Suppression des données au niveau du compte

Soumettez la suppression au niveau du compte pour un compte marchand géré en passant l'account_id géré, votre en-tête de compte parent et une clé d'idempotence :

curl -X POST "https://accounts.rokt.com/v1/partnership/accounts/$ACCOUNT_ID/data-deletion-requests" \
  -H "Authorization: Bearer $ROKT_TOKEN" \
  -H "X-Platform-Parent-Account-Id: $PARENT_ACCOUNT_ID" \
  -H "Idempotency-Key: $(uuidgen)"

Rokt vérifie que le compte parent possède le compte géré avant de soumettre la demande à l'API de suppression de données de compte. Le corps de la demande est vide ; le compte cible est pris du chemin.

La réponse utilise l'enveloppe de partenariat standard et renvoie 202 Accepted:

{
  "status": 202,
  "error": null,
  "message": "accepted",
  "request_id": "0e3a1b9c-1234-4abc-9def-aaaabbbbcccc",
  "data": {
    "request_id": "dad24980-de21-43e5-839b-cf66f840d9d1",
    "account_id": "<your-account-id>",
    "status": "submitted",
    "downstream_request_id": "delete-account-1",
    "message": "Partnership account data deletion request submitted to the Data Deletion API."
  }
}

Capturez les deux en-têtes de réponse :

X-Operation-Iduuid

ID de l'opération de partenariat. Interrogez GET /v1/partnership/operations/{operation_id} si votre client perd la réponse ou a besoin de confirmer l'achèvement.

X-Partnership-Account-Data-Deletion-Request-Iduuid

ID de demande de suppression de données de compte généré par Rokt.

Dry-run

Ajoutez ?dry_run=true pour valider l'authentification, la propriété, l'idempotence et le routage des requêtes sans soumettre au service de suppression en aval :

curl -X POST "https://accounts.rokt.com/v1/partnership/accounts/$ACCOUNT_ID/data-deletion-requests?dry_run=true" \
  -H "Authorization: Bearer $ROKT_TOKEN" \
  -H "X-Platform-Parent-Account-Id: $PARENT_ACCOUNT_ID" \
  -H "Idempotency-Key: $(uuidgen)"

Les réponses de dry-run incluent dry_run: true, omettent downstream_request_id, et ne portent pas X-Operation-Id car aucune opération n'est persistée. Les dry-runs consomment des clés d'idempotence, donc utilisez une nouvelle clé pour la véritable demande de suppression.

Gestion des données

L'API Accounts agit comme une couche d'entrée authentifiée. Elle ne conserve pas les identifiants bruts des consommateurs pour les demandes de confidentialité réseau, et elle ne conserve pas les corps de réponse en aval des services de confidentialité.

Connexes

Idempotency Keys

La suppression au niveau du compte utilise le contrat d'idempotence de partenariat normal.

Operation Polling

Utilisez X-Operation-Id pour récupérer les résultats de suppression au niveau du compte.