API REST

Última atualização: 19 de dezembro de 2024
  • Tópicos:

Criado para:

  • Administrador

O Marketo expõe uma API REST que permite a execução remota de muitos dos recursos do sistema. Desde a criação de programas até a importação de leads em massa, há muitas opções que permitem o controle refinado de uma instância do Marketo.

Essas APIs geralmente se encaixam em duas categorias amplas: Banco de Dados Principal e Ativo. As APIs de banco de dados de clientes potenciais permitem a recuperação e a interação com registros de pessoas da Marketo e tipos de objetos associados, como Oportunidades e Empresas. As APIs de ativos permitem a interação com material de apoio de marketing e registros relacionados a fluxos de trabalho.

NOTE
A API do SOAP está sendo descontinuada e não estará mais disponível após 31 de outubro de 2025. Todos os novos desenvolvimentos devem ser feitos com a REST API do Marketo, e os serviços existentes devem ser migrados até essa data para evitar interrupções no serviço. Se você tiver um serviço que usa a API SOAP, consulte a API SOAP Guia de Migração para obter informações sobre como migrar.
  • Cota Diária: as assinaturas recebem 50.000 chamadas de API por dia (que são redefinidas diariamente às 12h00 CST). Você pode aumentar sua cota diária por meio do gerente da conta.
  • Limite de Taxa: O acesso à API por instância é limitado a 100 chamadas por 20 segundos.
  • Limite de simultaneidade:  Máximo de dez chamadas de API simultâneas.

O tamanho das chamadas padrão é limitado a um comprimento de URI de 8 KB e um tamanho de corpo de 1 MB, embora o corpo possa ser de 10 MB para nossas APIs em massa. Se houver um erro na sua chamada, a API normalmente ainda retornará um código de status 200, mas a resposta JSON conterá um membro "success" com um valor de false e uma matriz de erros no membro "errors". Mais sobre os erros aqui.

Introdução

As etapas a seguir exigem privilégios de administrador na instância do Marketo.

Na primeira chamada para o Marketo, você recupera um registro de lead. Para começar a trabalhar com o Marketo, você deve obter credenciais de API para fazer chamadas autenticadas para sua instância. Faça logon na sua instância e acesse o Administrador -> Usuários e Funções.

Usuários e funções do administrador

Clique na guia Funções, em Novo Função e atribua pelo menos a permissão "Líder Somente Leitura" (ou "Pessoa Somente Leitura") à função no grupo de APIs de Acesso. Certifique-se de dar um nome descritivo e clique em Criar.

Nova Função

Agora, volte para a guia Usuários e clique em Convidar novo usuário. Dê ao usuário um nome descritivo que indique que ele é um usuário da API, um Endereço de email e clique em Avançar.

Novas Informações do Usuário

Em seguida, marque a opção API Somente e conceda ao usuário a função de API que você criou e clique em Avançar.

Novas permissões de usuário

Para concluir o processo de criação do usuário, clique em Enviar.

Nova Mensagem de Usuário

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

Ponto de inicialização

Clique no menu Novo e selecione Novo serviço. Dê um nome descritivo ao seu serviço e selecione Personalizado no menu suspenso Serviço. Forneça uma descrição, selecione seu novo usuário no menu suspenso Usuário único da API e clique em Criar.

Novo Serviço de Ponto de Inicialização

Clique em Exibir Detalhes do novo serviço para acessar a ID do Cliente e o Segredo do Cliente. Por enquanto, você pode clicar no botão Obter token para gerar um token de acesso válido por uma hora. Salve o token em uma nota por enquanto.

Obter token

Em seguida, vá para o menu Admin e depois para Serviços da Web.

Serviços da Web

Localize o Ponto de extremidade na caixa API REST e salve em uma observação por enquanto.

Ponto de extremidade REST

Ao fazer chamadas para métodos da API REST, um token de acesso deve ser incluído em cada chamada para que a chamada seja bem-sucedida. O token de acesso deve ser enviado como um cabeçalho HTTP.

Authorization: Bearer cdf01657-110d-4155-99a7-f986b2ff13a0:int
IMPORTANT
O suporte para autenticação usando o parâmetro de consulta access_token será removido em 30 de junho de 2025. Se o projeto usar um parâmetro de consulta para passar o token de acesso, ele deverá ser atualizado para usar o cabeçalho Autorização o mais rápido possível. O novo desenvolvimento deve usar o cabeçalho Autorização exclusivamente.

Abra uma nova guia do navegador e insira o seguinte, usando as informações apropriadas para chamar Obter clientes em potencial por Tipo de Filtro

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

Se você não tiver um registro de cliente potencial com seu endereço de email no banco de dados, substitua-o por um que você sabe que está lá. Pressione Enter na barra de URL e você deverá obter uma resposta JSON semelhante a:

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

Cada um dos usuários da API é relatado individualmente no relatório de uso da API, portanto, dividir os serviços da Web por usuário permite considerar facilmente o uso de cada uma de suas integrações. Se o número de chamadas de API para sua instância exceder o limite, causando falha nas chamadas subsequentes, o uso dessa prática permitirá considerar o volume de cada um dos serviços e avaliar como resolver o problema. Veja seu uso acessando Admin -> Integração > Serviços da Web e clicando no número de chamadas nos últimos sete dias.

Página anteriorPerfis de usuário
Próxima páginaAtivos

Marketo Engage