Antes de começar, aqui está o que você precisa:
- Uma conta do RD Station CRM, se ainda não tiver, crie uma aqui.
- Um pouco de conhecimento de programação.
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.
Requisitos
- As requisições devem ser enviadas no formato JSON;
- Todas as requisições devem ter o código Token da conta do RD Station CRM;
- O Modo Desenvolvedor deve ser previamente ativado, para facilitar a coleta do ID dos componentes.
Atenção: ao utilizar o método Listar de cada Entidade (Oportunidade, 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 Oportunidades e Empresas, utilizadas no corpo da requisição, deverão seguir o padrão da API, conforme o exemplo abaixo:
| RD Station CRM | API |
|---|---|
| Oportunidades | deal |
| Empresas | organization |
Ações possíveis com o uso da API
| Modelo/Ação | Criar | Atualizar | Excluir | Listar | Exibir |
|---|---|---|---|---|---|
| Token | ✘ | ✘ | ✘ | ✘ | ✓ |
| Tarefas | ✓ | ✓ | ✘ | ✓ | ✓ |
| Anotações | ✓ | ✘ | ✘ | ✓ | ✓ |
| Oportunidades | ✓ | ✓ | ✘ | ✓ | ✓ |
| Contatos da oportunidade | ✘ | ✘ | ✘ | ✓ | ✘ |
| Produtos em Oportunidades | ✓ | ✓ | ✓ | ✓ | ✘ |
| Usuários | ✘ | ✘ | ✘ | ✓ | ✓ |
| Equipes | ✘ | ✘ | ✘ | ✓ | ✓ |
| Empresas | ✓ | ✓ | ✘ | ✓ | ✓ |
| Contatos | ✓ | ✓ | ✘ | ✓ | ✓ |
| Produtos | ✓ | ✓ | ✘ | ✓ | ✓ |
| Campos personalizados | ✓ | ✓ | ✓ | ✓ | ✓ |
| Funil de Vendas | ✓ | ✓ | ✘ | ✓ | ✓ |
| Etapas do Funil de Vendas | ✓ | ✓ | ✘ | ✓ | ✓ |
| Campanhas | ✓ | ✓ | ✘ | ✓ | ✓ |
| Fontes | ✓ | ✓ | ✘ | ✓ | ✓ |