API REST

A API REST do Marketo fornece acesso remoto a vários recursos do sistema. Você pode usá-lo para criar programas, importar leads em massa e controlar uma instância do Marketo em um nível detalhado.

As REST APIs se dividem em duas categorias amplas:

As chamadas de API padrão têm um comprimento máximo de URI de 8 KB e um tamanho máximo de corpo de 1 MB. As chamadas de API em massa suportam um tamanho máximo de corpo de 10 MB.

Quando uma chamada contém um erro, a API normalmente ainda retorna o código de status HTTP 200. A resposta JSON contém um membro success com valor false e uma matriz de erros no membro errors. Mais informações sobre erros estão disponíveis aqui.

Introdução

Você precisa de privilégios de administrador na instância do Marketo para concluir as etapas a seguir. Este fluxo de trabalho cria credenciais de API e as usa para recuperar um registro de cliente potencial.

Primeiro, crie um usuário da API e obtenha credenciais para chamadas autenticadas. Faça logon na sua instância e acesse Administrador > Usuários e Funções.

Selecione a guia Funções e selecione Nova Função. Atribua à função pelo menos a permissão “Lead somente leitura” (ou “Pessoa somente leitura”) do grupo de APIs de acesso. Dê um nome descritivo à função e selecione Criar.

Retorne à guia Usuários e selecione Convidar Novo Usuário. Insira um nome descritivo que identifique o usuário como um usuário da API, insira um endereço de email e selecione Avançar.

Selecione a opção Somente API, atribua a função de API que você criou e selecione Avançar.

Selecione Enviar para criar o usuário.

Em seguida, vá para o menu Admin e selecione LaunchPoint.

Selecione Novo > Novo serviço. Insira um nome descritivo e uma descrição e selecione Personalizado no menu Serviço. Selecione o novo usuário no menu Somente Usuário da API e selecione Criar.

Selecione Exibir Detalhes para que o novo serviço acesse a ID do Cliente e o Segredo do Cliente. Selecione Obter Token para gerar um token de acesso válido por uma hora. Salve o token para a primeira chamada de API.

Vá para Admin > Serviços da Web.

Localize o Ponto de extremidade na caixa API REST e salve-o para a primeira chamada de API.

Todas as chamadas à API REST devem incluir um token de acesso em um cabeçalho HTTP.

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

Abra uma nova guia do navegador e insira o seguinte URL. Substitua os espaços reservados pelo ponto de extremidade e endereço de email da sua instância para chamar Obter Clientes Potenciais por Tipo de Filtro.

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

Se o banco de dados não contiver um registro de cliente potencial com seu endereço de email, use o endereço de email de um cliente potencial existente. Envie o URL para receber uma resposta JSON semelhante ao seguinte exemplo:

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

Utilização da API

O relatório de uso da API rastreia cada usuário da API separadamente. Atribuir um usuário separado a cada serviço da Web ajuda a identificar o uso da API de cada integração.

Se as chamadas excederem seu limite de instância e as chamadas subsequentes falharem, use o relatório para identificar o volume de chamadas de cada serviço. Vá para Admin > Integração > Serviços da Web e selecione o número de chamadas feitas nos últimos sete dias.

Para os pontos de extremidade REST que retornam estatísticas de uso e erro diárias e dos últimos sete dias, consulte Uso.