API REST

L’API REST Marketo permet d’accéder à distance à de nombreuses fonctionnalités système. Vous pouvez l’utiliser pour créer des programmes, importer des prospects en bloc et contrôler une instance Marketo à un niveau détaillé.

Les API REST se répartissent en deux grandes catégories :

Les appels d’API standard ont une longueur d’URI maximale de 8 Ko et une taille de corps maximale de 1 Mo. Les appels API en bloc prennent en charge une taille de corps maximale de 10 Mo.

Lorsqu’un appel contient une erreur, l’API renvoie généralement toujours le code d’état HTTP 200. La réponse JSON contient un membre de success avec une valeur de false et un tableau d’erreurs dans le membre de errors. Vous trouverez plus d’informations sur les erreurs ici.

Prise en main

Vous avez besoin de privilèges d’administrateur dans votre instance Marketo pour effectuer les étapes suivantes. Ce workflow crée des informations d’identification d’API et les utilise pour récupérer un enregistrement de prospect.

Créez tout d’abord un utilisateur d’API et obtenez les informations d’identification des appels authentifiés. Connectez-vous à votre instance et accédez à Admin > Utilisateurs et rôles.

Sélectionnez l’onglet Rôles, puis sélectionnez Nouveau rôle. Attribuez au rôle au moins l’autorisation « Lead en lecture seule » (ou « Personne en lecture seule ») à partir du groupe d’API Access. Attribuez un nom explicite au rôle et sélectionnez Créer.

Revenez à l’onglet ​ Utilisateurs ​ et sélectionnez Inviter un nouvel utilisateur. Saisissez un nom explicite qui identifie l’utilisateur en tant qu’utilisateur de l’API, saisissez une adresse e-mail, puis sélectionnez Suivant.

Sélectionnez l’option API uniquement, attribuez le rôle d’API que vous avez créé, puis sélectionnez Suivant.

Sélectionnez Envoyer pour créer l’utilisateur.

Ensuite, accédez au menu Admin et sélectionnez LaunchPoint.

Sélectionnez Nouveau > Nouveau service. Saisissez un nom et une description descriptifs, puis sélectionnez Personnalisé dans le menu Service. Sélectionnez votre nouvel utilisateur dans le menu Utilisateur API uniquement, puis sélectionnez Créer.

Sélectionnez Afficher les détails pour que le nouveau service accède à l’ID client et au secret client. Sélectionnez Obtenir le jeton pour générer un jeton d’accès valide pendant une heure. Enregistrez le jeton pour le premier appel API.

Accédez à Admin > Services web.

Recherchez le Point d’entrée dans la zone API REST et enregistrez-le pour le premier appel API.

Chaque appel de l’API REST doit inclure un jeton d’accès dans un en-tête HTTP.

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

Ouvrez un nouvel onglet du navigateur et saisissez l’URL suivante. Remplacez les espaces réservés par le point d’entrée et l’adresse e-mail de votre instance à appeler Get Leads by Filter Type.

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

Si votre base de données ne contient pas d’enregistrement de prospect avec votre adresse électronique, utilisez l’adresse électronique d’un prospect existant. Envoyez l’URL pour recevoir une réponse JSON similaire à l’exemple suivant :

{
    "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

Le rapport d’utilisation de l’API suit séparément chaque utilisateur de l’API. L’affectation d’un utilisateur distinct à chaque service web vous permet d’identifier l’utilisation de l’API de chaque intégration.

Si les appels dépassent votre limite d’instance et que les appels suivants échouent, utilisez le rapport pour identifier le volume d’appels de chaque service. Accédez à Admin > Intégration > Services web, puis sélectionnez le nombre d’appels effectués au cours des sept derniers jours.

Pour les points d’entrée REST qui renvoient des statistiques d’utilisation et d’erreur quotidiennes et des 7 derniers jours, voir Utilisation.