App: Minotaur Sales API
Publicado por: Minotaur Sales
Compatível com: app.minotaursales.io
Cada chave de API carrega um conjunto de permissões que definem exatamente o que ela pode fazer. Cada permissão é uma combinação de um sujeito (o recurso acessado) e uma ação (a operação realizada). Se uma requisição chegar a um endpoint que exige uma permissão que a chave não possui, a API retorna 403 Forbidden.
As permissões seguem o modelo sujeito:ação:
| Ação | Significado |
|---|
read | Listar, pesquisar ou recuperar registros |
create | Criar novos registros ou acionar operações do tipo criação |
update | Modificar registros existentes |
delete | Remover registros permanentemente |
Referência de permissões
Conta
| Permissão | O que permite |
|---|
customer:read | Recuperar o resumo da conta: informações do negócio, contagem de usuários e detalhes da assinatura ativa |
Contatos
| Permissão | O que permite |
|---|
contacts:read | Listar contatos, obter um contato individual, recuperar metadados de paginação |
contacts:create | Criar um novo contato (com empresa, lista e responsável opcionais) |
contacts:update | Atualizar campos do contato, reatribuir ou adicionar a listas |
contacts:delete | Excluir um contato permanentemente |
Empresas
| Permissão | O que permite |
|---|
companies:read | Listar empresas, obter uma empresa individual, recuperar metadados de paginação |
companies:create | Criar uma nova empresa |
companies:update | Atualizar campos da empresa |
companies:delete | Excluir uma empresa permanentemente |
Listas
| Permissão | O que permite |
|---|
list_contacts:read | Listar todas as listas de contatos, duplicar uma lista, acionar verificação de contatos |
list_contacts:create | Criar uma nova lista de contatos |
list_contacts:update | Renomear ou atualizar uma lista de contatos |
list_contacts:delete | Excluir uma lista de contatos |
list_contact_details:update | Adicionar contatos existentes a uma lista |
Produtos
| Permissão | O que permite |
|---|
products:read | Listar produtos ou recuperar um produto individual |
products:create | Criar um novo produto |
products:update | Atualizar campos do produto |
products:delete | Excluir um produto |
Oportunidades
| Permissão | O que permite |
|---|
opportunities:read | Listar oportunidades ou recuperar uma oportunidade individual |
opportunities:create | Criar uma oportunidade com contatos, estágio, produtos e responsável |
opportunities:update | Atualizar campos da oportunidade ou modificar produtos associados |
opportunities:delete | Excluir uma oportunidade |
Pipelines e Estágios
| Permissão | O que permite |
|---|
pipelines:read | Listar todos os pipelines ou recuperar um pipeline com seus estágios |
stages:read | Listar os estágios de um pipeline específico |
Prospectos (Descoberta de contatos)
| Permissão | O que permite |
|---|
prospect:read | Pesquisar no catálogo de prospectos, obter sugestões de filtros e metadados de paginação |
payment_prospect:create | Desbloquear contatos do catálogo (consome créditos da assinatura) |
Verificação de e-mails
| Permissão | O que permite |
|---|
verify_email:create | Iniciar a verificação de e-mails para uma lista de contatos (consome créditos de verificação) |
Atribuindo permissões
As permissões são selecionadas ao gerar uma chave de API em Configurações → API Keys → Gerar. Conceda apenas as permissões que sua integração realmente precisa — seguir o princípio do menor privilégio reduz o risco caso uma chave seja comprometida.
As permissões são imutáveis
Uma vez emitida a chave, seu conjunto de permissões não pode ser alterado. Para conceder permissões adicionais ou revogar as existentes, rotacione a chave (o que emite uma nova chave e invalida imediatamente a anterior) ou crie uma nova chave com o escopo desejado.
A rotação de uma chave é instantânea. Qualquer sistema que use a chave anterior começará a receber erros 401 imediatamente após a rotação.