Configuration de l'API
Documentation de l'API
Travaillez avec votre gestionnaire de compte Rokt pour finaliser le processus de configuration de l'API décrit ci-dessous.
La documentation de l'API peut inclure certains ou tous les points énumérés comme exigences tels que :
- Point de terminaison
- Méthode
- Corps
Cela devrait détailler exactement comment Rokt peut fournir des leads à votre système.
La documentation de l'API ainsi qu'un contact technique devraient être suffisants pour commencer le processus de configuration de l'API.
Pour un bon exemple de documentation de l'API, consultez la documentation de l'API Mailchimp.
Détails du contact technique
Fournissez le contact pertinent (vous-même ou quelqu'un d'autre de votre équipe) qui est le mieux placé pour répondre à toutes les questions sur le processus de configuration de l'API.
Le contact technique devrait être en mesure d'aider avec :
- Vérifier que les leads de test ont été enregistrés avec succès dans votre système
- Expliquer pourquoi nous recevons un statut de réponse 403
Par exemple :
John Smith
Support Technique
Point de terminaison
C'est l'emplacement où Rokt doit livrer les données. Si vous avez un point de terminaison de mise en scène ou de test, cela aidera l'équipe Rokt lors de la configuration et du processus de test afin qu'aucun test ne soit livré à votre CRM en direct.
Par exemple :
https://us9.api.mailchimp.com/3.0/lists/abcdefghij/members
Méthode
C'est le type de requête HTTP que Rokt utilise pour livrer les données à votre liste. La plupart du temps, il s'agit d'une requête POST.
Rokt prend en charge les méthodes de soumission suivantes :
- GET
- POST
- PUT
Authentification
Fournissez tous les détails d'authentification nécessaires pour que Rokt puisse appeler votre API. Cela peut prendre différentes formes, telles que :
- Nom d'utilisateur et mot de passe
- Une clé API
- Identifiant client et secret
Paramètres de l'API
Fournissez une liste de paramètres pour que Rokt les inclue dans chaque demande d'API. Si possible, précisez les éléments suivants :
- Attributs requis (attributs qui doivent être envoyés pour que la demande réussisse)
- Attributs facultatifs
- Noms de paramètres pour chaque attribut (par exemple, utiliser
firstname,FirstNameoufirst-name)
Les attributs courants comprennent :
- Prénom
- Nom de famille
- Source
- Pays
Pour référence, Rokt peut partager l'un de ces attributs.
Rokt prend en charge les encodages de corps suivants :
- JSON
- Encodage URL
- Texte brut
- XML
Réponses API attendues
En fournissant une liste des réponses API possibles, Rokt peut mettre en place une logique de gestion des réponses pour identifier rapidement les leads qui ont été livrés avec succès, par rapport à ceux qui n'ont pas pu être livrés ou qui ont été étiquetés comme des doublons.
La gestion des réponses peut être créée en fonction du code de statut que nous recevons ou du corps de la réponse, en fonction de la configuration de votre API.
Exemples de codes de statut :
- 201 (lead créé avec succès)
- 400 (non autorisé)
- 500 (erreur serveur)
Exemples de valeurs du corps de la réponse :
"livraison réussie"{"status": "doublon"}{"success": false}
En tant que partenaire Rokt, vous souhaiterez peut-être recevoir des données sur les clients qui interagissent avec les emplacements Rokt sur votre site afin de pouvoir intégrer ces données dans votre propre CRM ou tableau de bord de reporting. Notre plateforme de gestion des données offre la possibilité de recevoir un accès sécurisé et en temps réel aux données de transaction. L'une des options populaires consiste à intégrer les données de transaction via une API directement dans votre CRM.
Une API est le moyen le plus efficace pour Rokt de vous fournir des données de transaction. Cela fonctionne en temps réel, ce qui signifie que dès qu'un client interagit avec un emplacement sur votre site, le système Rokt peut communiquer l'événement à votre système. Il y a quelques éléments techniques nécessaires pour mener à bien cette intégration, qui sont décrits ci-dessous.