API REST

Marketo expose 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 pistes en bloc, il existe de nombreuses options qui permettent un contrôle précis d’une instance Marketo.

Ces API se répartissent généralement en deux grandes catégories : Base de données de piste et Ressource. Les API de base de données de piste permettent de récupérer les enregistrements de personne Marketo et les types d’objets associés, tels que les opportunités et les entreprises, ainsi que d’interagir avec ces derniers. Les API de ressources permettent l’interaction avec les documents marketing et les 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 avec votre appel, l’API renvoie généralement toujours un code d’état de 200, mais la réponse JSON contient un membre "success" avec une valeur de false et un tableau d’erreurs dans le membre "errors". Plus d'informations sur les erreurs ici.

Prise en main

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

Pour votre premier appel à Marketo, vous récupérez un enregistrement de piste. Pour commencer à utiliser Marketo, vous devez obtenir les informations d’identification d’API pour 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 affectez au moins l’autorisation "Lecture seule" (ou "Lecture seule personne") au rôle dans le groupe API d’accès. Veillez à lui donner un nom explicite et cliquez sur Créer.

Maintenant, revenez à l’onglet Utilisateurs et cliquez sur Inviter un nouvel utilisateur. Attribuez à votre utilisateur un nom explicite indiquant qu’il s’agit d’un utilisateur de l’API, ainsi qu’une adresse électronique, puis cliquez sur Suivant.

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

Pour terminer le processus de création de l’utilisateur, cliquez sur Envoyer.

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

Cliquez sur le menu New et sélectionnez New Service. Donnez 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 API Only User et cliquez sur Créer.

Cliquez sur Afficher les détails pour votre nouveau service afin d’accéder à 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.

Ensuite, accédez 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 à l’aide des 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 ne disposez pas d’un enregistrement de piste avec votre adresse électronique dans votre base de données, remplacez-le par un enregistrement que vous connaissez. Appuyez sur Entrée dans votre barre d’URL, et vous devez récupérer une réponse JSON semblable à celle-ci :

{
    "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. Par conséquent, le partage de vos services web par utilisateur vous permet de comptabiliser facilement l’utilisation de chacune de vos intégrations. Si le nombre d’appels API à votre instance dépasse la limite et provoquent l’échec des appels suivants, cette pratique vous permet de comptabiliser le volume de chacun de vos services et vous permet d’évaluer la manière de résoudre le problème. Pour afficher votre utilisation, accédez à Admin -> Intégration > Services web et cliquez sur le nombre d’appels au cours des sept derniers jours.