Introdução e requisitos

Bem-vindo à documentação da API V2 do RD Station CRM, projetada para ser poderosa, previsível e fácil de usar. Com ela, você pode criar
integrações robustas para estender e conectar o RD Station CRM a outras ferramentas.

Esta documentação é dividida em seções para te ajudar a encontrar o que precisa, desde primeiros passos até a referência detalhada de cada recurso.

A API (Application Programming Interface ou Interface de Programação de Aplicativos) é um padrão de programação, com conjuntos de instruções cuja finalidade é desenvolver a integração entre diferentes plataformas de softwares, como o RD Station CRM e outra ferramenta que você utilize.

Aqui você vai encontrar a coleção de recursos do RD Station CRM para 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.
• 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.

Requisitos para começar

• Possuir uma conta do RD Station CRM, se ainda não tiver, crie uma aqui.
• As requisições devem ser enviadas no formato JSON;
• Todas as requisições devem ser autenticadas via Bearer Token;
• O Modo Desenvolvedor deve ser previamente ativado, para facilitar a coleta do ID dos componentes;
• Ter uma conta do plano Basic, Pro ou Advanced do RD Station CRM.
• Um pouco de conhecimento de programação.

Limites

Ao utilizar o método Listar de cada Entidade (Negociação, Empresa e Contato) é possível listar apenas as 10 mil primeiras linhas a cada requisição.
A API tem um limite de 120 requisições por minuto.

Mapeamento de nomenclaturas

As nomenclaturas de Negociações, Empresas e Contatos, utilizadas no corpo da requisição, deverão seguir o padrão da API, conforme o exemplo abaixo:

Guia de Início Rápido

O objetivo deste guia é te levar da estaca zero à sua primeira chamada de API bem-sucedida em menos de 5 minutos.

Passo 1: Autentique sua Requisição

Para interagir com a API, é necessária a autenticação via Bearer Token.
Sua chave de API deve ser incluída no cabeçalho Authorization de todas as requisições à API V2. Para detalhes adicionais sobre autenticação, consulte a seção de Conceitos Fundamentais.

Authorization: Bearer SUA_CHAVE_DE_API

Passo 2: Faça sua Primeira Chamada

Vamos fazer uma requisição simples para listar seus contatos.
Abra seu terminal e cole o comando cURL abaixo, substituindo SUA_CHAVE_DE_API pela sua chave.

curl --request GET \
--url https://api.rd.services/v2/contacts \
--header \'Authorization: Bearer SUA_CHAVE_DE_API\' \
--header \'Content-Type: application/json\'

Passo 3: Entenda a Resposta

Se a requisição for bem-sucedida, você receberá uma resposta com o código de status 200 OK e um corpo em formato JSON contendo uma lista dos seus contatos, semelhante a este exemplo:

{
  "contacts": [
    {
      "id": "60c72b1f9c8f1a001c8c4f35",
      "name": "Jesse Pinkman",
      "emails": [
        { "email": "[email protected]" }
      ],
      # ...
    }
  ],
  "total": 1,
  "has_more": false
}

Parabéns! Você fez sua primeira chamada à API V2.