CUBO CRM
    CUBO CRM
    • Comece por aqui
    • Activities
      • Listar todas as atividades
        GET
      • Criar nova atividade
        POST
      • Obter atividade por ID
        GET
      • Atualizar atividade
        PUT
      • Excluir atividade
        DELETE
    • Annotation
      • Criar nova anotação
        POST
      • Obter anotação por ID
        GET
      • Atualizar anotação
        PUT
      • Excluir anotação
        DELETE
    • Apikey
      • Listar todas as apikeys
        GET
      • Criar nova apikey
        POST
      • Obter apikey por ID
        GET
      • Atualizar apikey
        PUT
      • Excluir apikey
        DELETE
    • Category
      • Listar todas as categorias
        GET
      • Criar nova categoria
        POST
      • Obter categoria por ID
        GET
      • Atualizar categoria
        PUT
      • Excluir categoria
        DELETE
    • Company
      • Obter empresa
        GET
      • Atualizar empresa
        PUT
    • Custom Field
      • Listar todos os campos personalizados
        GET
      • Criar novo campo personalizado
        POST
      • Obter campo personalizado por ID
        GET
      • Atualizar campo personalizado
        PUT
      • Excluir campo personalizado
        DELETE
    • Deal
      • Listar todos os negócios
      • Criar novo negócio
      • Obter negócio por ID
      • Atualizar negócio
      • Excluir negócio
    • Domain
      • Listar todos os domínios
      • Criar novo domínio
      • Obter domínio por ID
      • Excluir domínio
    • LostReason
      • Listar todos os motivos de perda
      • Criar motivo de perda
      • Obter motivo de perda por ID
      • Atualizar motivo de perda
      • Excluir motivo de perda
    • Organization
      • Listar todas as organizações
      • Criar nova organização
      • Obter organização por ID
      • Atualizar organização
      • Excluir organização
    • People
      • Listar todas as pessoas
      • Criar nova pessoa
      • Obter pessoa por ID
      • Atualizar pessoa
      • Excluir pessoa
    • Pipe
      • Listar todos os funis
      • Criar novo funil
      • Listar funil por ID
      • Atualizar Funil
      • Excluir funil
    • Product
      • Listar todos os produtos
      • Criar novo produto
      • Obter produto por ID
      • Atualizar produto
      • Excluir produto
    • Proposal
      • Listar todos as propostas
      • Criar proposta para negociação pelo ID
      • Obter proposta por ID
      • Atualizar proposta
    • Stage
      • Buscar todos os estágios do funil pelo ID
      • Criar estágios
      • Obter estágios por ID
      • Atualizar estágio
      • Excluir estágio
    • Template
      • Listar todos os templates de mensagem
      • Criar template de mensagem
      • Criar template de mensagem para negócio pelo ID
      • Obter template de mensagem por ID
      • Atualizar template de mensagem
      • Excluir template de mensagem
    • Webhooks
      • Receber dados do BotConversa para criação
      • Receber dados do BotConversa para atualização
      • Receber dados do ManyChat para criação
      • Receber dados do ManyChat para atualização

    Comece por aqui

    Tutorial: Primeiros Passos com a API do Cubo CRM#

    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 API Key no Cubo CRM.
    Configurar a APIKey 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#

    Conta ativa no Cubo CRM.
    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.

    Tutorial: Primeiros Passos com a API do Cubo CRM#

    Passo a Passo: Como Criar e Usar a APIKey#

    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.

    Passo 2: Acesse o Menu "Meu Perfil"#

    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 APIKey#

    Na seção Chaves API, você verá:
    Uma lista de APIKeys já criadas (se houver).
    Um botão ou opção para Criar uma Nova API Key.
    Para criar uma nova chave:
    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.
    Caso já tenha uma chave existente e deseja usá-la, copie a chave listada.
    Atenção:
    Mantenha a APIKey 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çãoDescriçãoMétodo HTTP
    ListarRetorna lista paginadaGET
    CriarCria uma nova entidadePOST
    VisualizarDetalha uma entidade específicaGET
    AtualizarAltera dados ou status da entidadePUT
    ExcluirRemove uma entidadeDELETE

    Passo 5: Configurar a APIKey como Bearer Token#

    Para acessar as rotas da API do Cubo CRM, você deve incluir a API Key no cabeçalho (header) de todas as requisições HTTP.
    O formato do cabeçalho deve ser:
    Authorization: Bearer <SUA_API_KEY>

    Passo 6: Realizar uma Requisição com a APIKey#

    Para utilizar qualquer uma das rotas disponíveis na API do Cubo CRM (como listadas na seção Operações Disponíveis), siga o mesmo padrão de autenticação. Todas as rotas requerem o cabeçalho:
    Authorization: Bearer <SUA_API_KEY>
    Exemplo com cURL:#
    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.
    Próxima página
    Activities
    Built with