Referência do ponto de extremidade

Referência do ponto de extremidade

O Marketo usa o Swagger para fornecer uma definição formal da interface pública para suas APIs REST. O Swagger fornece um modelo de definição avançado para estruturas de URL, modelos de solicitação e modelos de resposta, e tem um ecossistema desenvolvido de ferramentas para uso com interação de API, testes e geração de clientes.

A referência de ponto de extremidade usa o pacote JavaScript Swagger-UI para gerar as páginas de referência no lado do cliente. Cada endpoint público é listado e fornece a estrutura do modelo de resposta, os parâmetros de solicitação necessários e o modelo de solicitação, se necessário.

Uso das definições do Swagger da Marketo

O padrão Swagger exige que um host seja fornecido ou que o host seja gerado pelo host que atende o arquivo. É importante corrigir o host na definição antes de empregar qualquer ferramenta existente, pois o Marketo fornece um parâmetro de host vazio com a definição. O host da API REST para cada instância do Marketo é exclusivo e segue o padrão:

{Munchkin ID}.mktorest.com

APIs de ativos

As APIs de Ativo do Marketo usam parâmetros de estilo application/x-www-url-formencoded em solicitações para pontos de extremidade que exigem um método POST. Em alguns casos, no entanto, como parâmetros de pasta, o valor do parâmetro pode ser uma matriz JSON ou um objeto. Esses parâmetros são anotados na referência do endpoint.