API REST

Marketo propose une API REST qui permet l’exécution à distance de nombreuses fonctionnalités du système. De la création de programmes à l’importation de leads en bloc, il existe de nombreuses options permettant un contrôle affiné d’une instance Marketo.

Ces API se répartissent généralement en deux grandes catégories : Base de données de lead et Ressource. Les API de base de données de leads permettent de récupérer les enregistrements de personne Marketo et les types d’objet associés, tels que les opportunités et les entreprises, ainsi que d’interagir avec eux. Les API de ressources permettent l’interaction avec des dérivés marketing et des enregistrements liés aux workflows.

La taille des appels standard est limitée à une longueur d’URI de 8 Ko et à une taille de corps de 1 Mo, bien que le corps puisse être de 10 Mo pour nos API en bloc. En cas d’erreur dans votre appel , l’API renvoie généralement un code d’état de 200, mais la réponse JSON contient un membre « success » avec une valeur de false, ainsi qu’un tableau d’erreurs dans le membre « errors ». En savoir plus sur les erreurs ici.

Prise en main

Les étapes suivantes nécessitent des privilèges d’administrateur dans votre instance Marketo.

Lors de votre premier appel à Marketo, vous récupérez un enregistrement de prospect. Pour commencer à utiliser Marketo, vous devez obtenir des informations d’identification d’API afin d’effectuer des appels authentifiés vers votre instance . Connectez-vous à votre instance et accédez à Admin -> Utilisateurs et rôles.

Cliquez sur l’onglet Rôles, puis sur Nouveau rôle et attribuez au moins l’autorisation « Lead en lecture seule » (ou « Personne en lecture seule ») au rôle dans le groupe API Access . Veillez à lui donner un nom explicite et à cliquer sur Créer.

Revenez maintenant à l’onglet Utilisateurs et cliquez sur Inviter un nouvel utilisateur. Donnez à votre utilisateur un nom explicite qui indique qu’il s’agit d’un utilisateur d’API, ainsi qu’une adresse électronique, puis cliquez sur Suivant.

Ensuite, cochez l’option API uniquement et attribuez à votre utilisateur le rôle d’API que vous avez créé, puis cliquez sur Suivant.

Pour terminer le processus de création d’utilisateurs, cliquez sur Envoyer.

Ensuite, accédez au menu Admin et cliquez sur LaunchPoint.

Cliquez sur le menu Nouveau et sélectionnez Nouveau service. Attribuez un nom explicite à votre service et sélectionnez Personnalisé dans le menu déroulant Service. Donnez-lui une description, puis sélectionnez votre nouvel utilisateur dans le menu déroulant Utilisateur API uniquement et cliquez sur Créer.

Cliquez sur Afficher les détails pour que votre nouveau service accède à l’ID client et au secret client. Pour l’instant, vous pouvez cliquer sur le bouton Obtenir le jeton pour générer un jeton d’accès valide pendant une heure. Enregistrez le jeton dans une note pour l’instant.

Accédez ensuite au menu Admin, puis à Services web.

Recherchez le ​ Point d’entrée ​ dans la zone API REST et enregistrez-le dans une note pour l’instant.

Lors d’appels aux méthodes de l’API REST, un jeton d’accès doit être inclus dans chaque appel pour que l’appel réussisse. Le jeton d’accès doit être envoyé en tant qu’en-tête HTTP.

Authorization: Bearer cdf01657-110d-4155-99a7-f986b2ff13a0:int

Ouvrez un nouvel onglet du navigateur et saisissez les informations suivantes en utilisant les informations appropriées pour appeler Get Leads by Filter Type

<Your Endpoint URL>/rest/v1/leads.json?&filterType=email&filterValues=<Your Email Address>

Si vous n’avez pas d’enregistrement de prospect avec votre adresse e-mail dans votre base de données, remplacez-le par un enregistrement dont vous savez qu’il existe. Appuyez sur Entrée dans votre barre d’URL et vous devriez récupérer une réponse JSON ressemblant à ceci :

{
    "requestId":"c493#1511ca2b184",
    "result":[
       {
           "id":1,
           "updatedAt":"2015-08-24T20:17:23Z",
           "lastName":"Elkington",
           "email":"developerfeedback@marketo.com",
           "createdAt":"2013-02-19T23:17:04Z",
           "firstName":"Kenneth"
        }
    ],
    "success":true
}

Utilisation de l’API

Chacun de vos utilisateurs d’API est signalé individuellement dans le rapport d’utilisation de l’API. La division de vos services web par utilisateur vous permet donc de rendre compte facilement de l’utilisation de chacune de vos intégrations. Si le nombre d’appels d’API à votre instance dépasse la limite et provoque l’échec des appels suivants, l’utilisation de cette pratique vous permet de tenir compte du volume de chacun de vos services et d’évaluer comment résoudre le problème. Consultez votre utilisation en accédant à Admin -> Intégration > Services web et en cliquant sur le nombre d’appels au cours des sept derniers jours.