Conceitos fundamentais

Esta seção aborda conceitos que se aplicam a toda a API, fornecendo uma
base sólida para a construção de suas integrações.

Autenticação

Todas as requisições à API V2 devem ser autenticadas. Utilize o método
Bearer Token, incluindo sua chave de API no cabeçalho Authorization.
Para mais detalhes visite: autenticação

Limite de requisições da API

Para garantir a estabilidade da plataforma para todos os usuários, a API impõe limites no número de requisições que podem ser feitas em um determinado período.
Se você exceder esse limite, receberá uma resposta com o código de status 429 Too Many Requests. A resposta incluirá um cabeçalho Retry-After indicando quantos segundos você deve esperar antes de fazer uma nova tentativa.

Limite máximo	Período	Método HTTP	Plano
120 Requisições	1 Minuto	`GET`, `POST`, `PUT`, `DELETE`	Basic, Pro, Advanced

📌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.

Tratamento de Erros

A API V2 utiliza códigos de status HTTP padrão para indicar o sucesso ou a falha de uma requisição.

Código	Significado	Descrição
200 OK	Sucesso	A requisição foi bem-sucedida.
201 Created	Criado	O recurso foi criado com sucesso (usado em respostas a POST).
204 No Content	Sem Conteúdo	A requisição foi bem-sucedida, mas não há conteúdo para retornar (usado em respostas a DELETE).
400 Bad Request	Requisição Inválida	A requisição está malformada, como um corpo JSON inválido ou parâmetros ausentes.
401 Unauthorized	Não Autorizado	A chave de API está ausente, inválida ou expirada.
403 Forbidden	Proibido	Você não tem permissão para acessar o recurso solicitado.
404 Not Found	Não Encontrado	O recurso solicitado não existe.
429 Too Many Requests	Muitas Requisições	Você excedeu o limite de taxa.
500 Internal Server Error	Erro interno	Erro Interno do Ocorreu um erro inesperado no servidor

Bases legais

As principais Leis de Proteção de Dados, como a LGPD (Brasil) e o GDPR (União Europeia), estabelecem que, para que qualquer pessoa, física ou jurídica, possa realizar qualquer operação com um dado pessoal --- seja coletar, transmitir ou processar ---, é necessário possuir uma base legal presente na LGPD, ou seja, uma hipótese da lei que justifique o tratamento desses dados.

A LGPD prevê bases legais que autorizam o tratamento de dados pessoais. As bases legais não têm dependência ou predominância entre si, e para todo caso de tratamento de dados, existe uma base legal mais apropriada.

A atribuição das bases legais aos contatos do RD Station CRM para Contato e envio de comunicação engloba envio de e-mails e a prática de ligações via RD Station CRM.

É possível adicionar as seguintes bases legais:

Consentimento (consent)
Legítimo interesse (legitimate_interest)
Contrato preexistente (pre_existent_contract)
Obrigação legal (judicial_process)
Execução de políticas públicas (public_interest)
Processo Judicial (judicial_process)
Proteção da vida (vital_interest)
Tutela da saúde (vital_interest)
Proteção do crédito (judicial_process)

Saiba mais sobre os conceitos e cada uma das Bases Legais aqui.

Como registrar as Bases Legais

O registro das Bases Legais é realizado a partir dos seguintes parâmetros:

Campo	Tipo	Parâmetros válidos	Descrição
category	String	`communications` ou `data_processing`	Categorias aceitas: "Comunicação" e "Processamento de dados".
type	String	`pre_existent_contract`, `consent`, `legitimate_interest`, `judicial_process`, `vital_interest` ou `public_interest`	Qual base legal autoriza o tratamento de dados pessoais.
status	String	`granted` ou `declined`	Valores aceitos: `granted` para confirmar o consentimento e `declined` para indicar que o consentimento foi recusado.

Exemplo de como os parâmetros devem ser enviados:

"legal_bases": [
  {
    "category": "data_processing",
    "type": "consent",
    "status": "granted"
  },
  {
    "category": "communications",
    "type": "vital_interest",
    "status": "granted"
  }
]

Paginação

Endpoints que retornam listas de recursos (como GET /contacts ou GET /deals) utilizam paginação para gerenciar grandes volumes de dados.
Use os parâmetros de consulta page e per_page para navegar pelos resultados.
A resposta incluirá informações sobre o total de registros e se há mais páginas disponíveis.

Filtros

Saiba mais sobre filtros aqui