Concepts
Cette surface API est destinée aux partenaires d'intégration construisant sur le réseau Rokt. Les partenaires e-commerce de Rokt intégrant des placements sur leur propre page de paiement devraient utiliser à la place les documents développeur Rokt Ecommerce.
La surface de l'API de Partenariats est petite, mais une poignée de concepts façonnent le comportement de chaque point de terminaison. Lisez-les une fois avant de connecter votre intégration ; ce sont les contrats qui régissent les nouvelles tentatives, les sémantiques de remplacement vs patch, les écritures asynchrones, la traduction de taxonomie, et comment les surfaces se mappent aux appels SDK sur la page du marchand.
Ordre de lecture recommandéLien direct vers Ordre de lecture recommandé
Si vous effectuez une intégration de bout en bout, suivez ces étapes dans l'ordre. Les concepts précédents sont des prérequis pour les suivants ; par exemple, chaque écriture que vous effectuez dans les flux d'enregistrement et de contrôle nécessite une clé d'idempotence et peut révéler un identifiant d'opération que vous devrez interroger.
Votre plateforme est le gestionnaire ; les marchands que vous intégrez sont des comptes gérés. Lisez ceci lorsque vous êtes sur le point d'effectuer votre premier appel authentifié.
Chaque écriture nécessite Idempotency-Key. Même clé, même réponse, donc il est sûr de réessayer. Le reste de l'API le suppose.
Les points de terminaison de contrôle (MCL, statut) sont des remplacements PUT, pas des PATCH. Envoyez l'état souhaité complet à chaque fois. Lisez ceci avant votre première mise à jour des contrôles.
dry_run=true exécute la validation complète et renvoie la réponse potentielle sans persister l'état. Lisez ceci lorsque vous êtes sur le point de valider une charge utile avant de passer en production.
Les écritures retournent X-Operation-Id. Utilisez-le pour récupérer le résultat d'une écriture dont vous avez perdu la réponse. Lisez ceci une fois que vous comprenez l'idempotence.
Bloquez les verticales dans votre taxonomie de partenaires ; Rokt traduit côté serveur. Lisez ceci lorsque vous commencez à construire des contrôles de marché.
Comment les surfaces (confirmation, suivi, retours) se mappent aux page_identifiers et comment fonctionne le PATCH du thème V1. Lisez ceci avant l'intégration du SDK.
Désactivation du réseau, suppression des données du réseau et suppression des données des comptes gérés. Lisez ceci lors de l'ajout de flux de demandes de confidentialité.