Este tutorial é o ponto de partida para entender como utilizar a documentação da API do Cubo CRM. Aqui, você aprenderá como criar uma APIKey no Cubo CRM, como usá-la como Bearer Token nas requisições. O guia inclui um passo a passo detalhado, um fluxograma visual para facilitar a integração com a API.Objetivo#
Ensinar desenvolvedores a:Acessar e criar uma chave de API no Cubo CRM.
Configurar a chave de API como um Bearer Token no cabeçalho (header) das requisições.
Utilizar a documentação para acessar todas as rotas disponíveis da API.
Pré-requisitos#
Acesso ao painel de administração do Cubo CRM.
Ferramenta para testar requisições HTTP, como Postman, cURL ou similar.
Conhecimento básico em APIs REST e headers HTTP.
Passo a Passo: Como Criar e Usar a Chave de API#
Passo 1: Acesse o Cubo CRM#
1.
Faça login no Cubo CRM utilizando suas credenciais (e-mail e senha).
2.
Após o login, você será redirecionado para o painel principal do Cubo CRM.
1.
No canto superior direito da tela, localize o nome do usuário logado.
2.
Clique no nome do usuário para abrir o menu suspenso.
3.
No menu, selecione a opção Meu Perfil.
Passo 3: Abra o Modal de Configurações do Perfil#
1.
Ao clicar em Meu Perfil, um modal será exibido com as configurações do seu perfil.
2.
No modal, localize a seção ou aba chamada Chaves API.
Passo 4: Criar ou Selecionar uma chave de API#
Na seção Chaves API, você verá:Uma lista de chaves de API já criadas (se houver).
Um botão ou opção para Criar uma Nova APIKey.
1.
Clique no botão Criar Nova APIKey.
2.
O sistema gerará uma chave única (uma string alfanumérica).
3.
Copie a API Key imediatamente e armazene-a em um local seguro, pois ela não será exibida novamente.
Mantenha a Chave de API em sigilo. Não a compartilhe publicamente ou em repositórios de código.
Se suspeitar que a chave foi comprometida, gere uma nova e revogue a antiga na mesma seção.
Fluxo de Uso#
Operações Disponíveis#
| Operação | Descrição | Método HTTP |
|---|
| Listar | Retorna lista paginada | GET |
| Criar | Cria uma nova entidade | POST |
| Visualizar | Detalha uma entidade específica | GET |
| Atualizar | Altera dados ou status da entidade | PUT |
| Excluir | Remove uma entidade | DELETE |
Passo 5: Configurar a Cahve de API como Bearer Token#
Para acessar as rotas da API do Cubo CRM, você deve incluir a chave de API no cabeçalho (header) de todas as requisições HTTP.O formato do cabeçalho deve ser:Authorization: Bearer <SUA_API_KEY>
Para utilizar qualquer uma das rotas disponíveis na API do Cubo CRM, siga o mesmo padrão de autenticação. Todas as rotas requerem o cabeçalho:
Authorization: Bearer <SUA_API_KEY>
O método de autenticação é sempre o mesmo, utilizando o cabeçalho Authorization com o formato Bearer Token.
Consulte a documentação abaixo para obter detalhes completos sobre cada rota, seus parâmetros e os formatos dos payloads.
Modificado em 2025-06-16 13:40:33
