API Rest

A melhor developer experience para você

A API é o principal meio para os desenvolvedores acessarem uma coleção de recursos do RD Station e realizar a integração com o seu sistema. Veja a seguir alguns pontos importantes:

  • API RESTful - Todas as nossas APIs são organizadas em torno da arquitetura REST e são acessadas via HTTP. Então, se você já interagiu com uma API RESTful, muitos dos conceitos serão familiares.
  • Domínio base - Todas as chamadas de API para o RD Station Marketing devem ser feitas para o domínio base https://api.rd.services.
  • Respostas da API - Todas as respostas da API, incluindo casos de erro, serão retornados em formato JSON.
  • URLs previsíveis - As APIs são projetadas para ter URLs previsíveis para acessar recursos e utilizam os códigos de resposta HTTP para indicar erros da API.
  • Tokens de acesso RD Station Marketing - Dentro do escopo da nossa API 2.0, existem duas formas de autenticação para RD Station Marketing: Oauth2 e API Key.
    • Oauth2: é utilizada para enviar eventos, marcar e desmarcar oportunidades, registrar vendas, atualizar contatos sem conversão, consultar diversas informações do RD Station Marketing, e os demais recursos disponíveis.
    • API Key: é utilizada exclusivamente para envio de eventos de conversão para criar e atualizar contatos com o registro de uma conversão. É recomendada para integração de formulários e sistemas internos que enviam conversões para o RD Station Marketing.
  • Token de acesso RD Station CRM: Todas as requisições devem ter o código Token do usuário da conta do RD Station CRM;

📘

Caso você não tenha ouvido falar de RESTful, recomendamos este guia externo como referência.