Como funciona a integração via API? | Portal de Suporte Reev

A API é um conjunto de regras que permite que diferentes softwares se comuniquem entre si. No caso do Reev, a API possibilita que você integre suas ferramentas externas com a plataforma, automatizando processos e melhorando a eficiência.

Principais funcionalidades da API do Reev

Gerenciamento de Contatos: Você pode criar, atualizar, listar e remover contatos na sua base do Reev através de comandos na API.
Campos Personalizados: A API permite listar, criar, atualizar e remover campos customizados, adaptando o Reev às necessidades específicas do seu negócio.
Fluxos de Trabalho: É possível listar fluxos e adicionar contatos a eles, automatizando etapas do seu processo comercial.
Tags: Gerencie tags para categorizar e organizar seus contatos de forma eficiente.
Usuários: Liste os usuários da sua conta para melhor controle e atribuição de tarefas.

Como começar a usar a API do Reev

Obtenha seu Token de API: Para acessar a API, você precisará de um api_token. Este token pode ser adquirido acessando o Reev, indo em Configurações > Integrações.
Autenticação: Inclua o api_token em suas requisições para autenticar e garantir acesso aos recursos da API.

Limite de Requisições: A API tem um limite de 30 requisições a cada 10 segundos. Se você ultrapassar esse limite, receberá um status 429, indicando que muitas requisições foram feitas em um curto período.

Como fazer uma requisição na API do Reev?

Para usar a API do Reev, você precisará configurar suas requisições corretamente. Aqui está um guia detalhado para ajudá-lo:

1. Escolha um framework para desenvolvimento

Você pode usar ferramentas como Node.js, Ruby on Rails, ou outros frameworks para fazer as requisições. Certifique-se de que seu time de TI esteja envolvido na implementação dessa integração.

2. Exemplo de requisição: Adicionando um contato

Aqui está um exemplo de como fazer uma requisição POST para criar um novo contato no Reev usando a API.

Requisição HTTP:

POST /v1/contacts HTTP/1.1  
Host: api.reev.co  
Authorization: Bearer SEU_API_TOKEN  
Content-Type: application/json

Corpo da requisição:

{  
  "first_name": "João",  
  "last_name": "Silva",  
  "email": "[email protected]",  
  "telephone": "+55(11) 1234-5678",  
  "tags": ["Cliente Potencial", "Campanha Novembro"],  
  "custom_fields": [  
    { "field": "Setor", "value": "Tecnologia" }  
  ]  
}

Resposta esperada (Sucesso - HTTP 201):

{  
  "id": "12345",  
  "first_name": "João",  
  "last_name": "Silva",  
  "email": "[email protected]",  
  "status": "lead",  
  "created_at": "2024-12-17T12:00:00Z"  
}

3. Passo a passo para executar a requisição

Escolha sua ferramenta:
Você pode usar bibliotecas como Axios (Node.js) ou Net::HTTP (Ruby) para enviar a requisição.

Configuração no código:
Exemplo usando Node.js com Axios:

const axios = require('axios');  

const apiUrl = 'https://api.reev.co/v1/contacts';  
const apiToken = 'SEU_API_TOKEN';  

const novoContato = {  
  first_name: 'João',  
  last_name: 'Silva',  
  email: '[email protected]',  
  telephone: '+55(11) 1234-5678',  
  tags: ['Cliente Potencial', 'Campanha Novembro'],  
  custom_fields: [  
    { field: 'Setor', value: 'Tecnologia' }  
  ]  
};  

axios.post(apiUrl, novoContato, {  
  headers: {  
    Authorization: `Bearer ${apiToken}`,  
    'Content-Type': 'application/json'  
  }  
})  
.then(response => {  
  console.log('Contato criado com sucesso:', response.data);  
})  
.catch(error => {  
  console.error('Erro ao criar contato:', error.response.data);  
});

Exemplos de uso

Criar um novo contato:
Para adicionar um contato, envie uma requisição POST para /v1/contacts com os dados do contato no corpo da mensagem.
Atualizar um contato existente:
Envie uma requisição PUT para /v1/contacts/:id com as informações atualizadas, substituindo :id pelo identificador do contato.
Listar todos os contatos:
Faça uma requisição GET para /v1/contacts?page=:page para obter uma lista paginada de contatos, substituindo :page pelo número da página desejada.

Onde encontrar mais informações

Para detalhes técnicos e uma lista completa de recursos disponíveis, consulte a Documentação da API do Reev. Lá você encontrará exemplos práticos e orientações para implementar a integração conforme suas necessidades.

E se eu precisar enviar dados do Reev para outras ferramentas?

Caso a necessidade seja transferir informações do Reev para outro sistema, recomendamos usar o recurso de Webhook, que oferece uma maneira simples de realizar essa integração.

Precisa de Ajuda?

Se você tiver qualquer dúvida ou precisar de assistência adicional, estamos aqui para ajudar! Entre em contato conosco utilizando o chat de suporte no canto inferior da plataforma ou envie um e-mail para [email protected]. 😊