Documentação da API
Referência da API do ProcessMind: endpoints, autenticação e guias de integração para desenvolvedores.
Nesta página
Comece agora
Fundamentos de processos
Arquitetura de processos
Inteligência de processos
Dados
Administração
Referência
Chaves de API
Gerenciamento de chaves de API no ProcessMind
Para integrar a API do ProcessMind, você precisa criar e gerenciar chaves de API. Saiba como gerar, usar e proteger suas chaves de API.
Nas configurações da sua conta do ProcessMind, acesse a seção “Chaves de API”. Nessa tela, você pode criar uma nova chave de API clicando no botão Nova chave de API do ambiente. Dê um nome à chave para identificá-la depois.
Criar uma chave de API
Você pode criar várias chaves de API para diferentes aplicativos ou serviços. Cada chave pode ser gerenciada de forma independente, permitindo revogar chaves quando necessário sem afetar outras integrações. Depois que a chave for gerada, copie-a e armazene-a com segurança. Por motivos de segurança, a chave será exibida apenas uma vez durante a criação.
warning
Mantenha suas chaves de API protegidas e nunca as exponha em código do lado do cliente ou em repositórios públicos. Se uma chave for comprometida, revogue-a imediatamente e gere uma nova.
Chaves de API da organização
Os administradores da organização também podem criar chaves de API da organização na mesma página. Diferentemente das chaves de ambiente, uma chave da organização funciona em todos os ambientes (tenants) da organização, permitindo que uma única integração atenda a todos eles. Use chaves da organização para:
- Provisionar chaves de API de ambientes: criar, atualizar e excluir chaves vinculadas a tenants pela API externa (
/v1/tenant/{tenantId}/api-keys). - Gerar links de login de uso único: enviar um usuário do seu próprio produto diretamente para o ProcessMind, já autenticado (
/v1/tenant/{tenantId}/users/{userId}/login-token).
Escopos
| Escopo | Permissões |
|---|---|
| read | Ler dados do tenant (endpoints de listagem/consulta). Ativado por padrão. |
| write | Criar, atualizar e excluir dados do tenant. Ativado por padrão. |
| uploadData | Solicitar URLs de upload pré-assinadas para tabelas de dados. Ativado por padrão. |
| sessions | Gerar tokens de handoff de login de uso único. Desativado por padrão. |
Ative sessions apenas para chaves que precisam fazer handoff de login e trate essas chaves como senhas: um token gerado faz o login do usuário sem solicitar uma senha. Uma chave da organização pode gerar tokens para usuários de todos os ambientes da organização; uma chave de ambiente pode fazer isso apenas para usuários do próprio ambiente.
Handoff de login de uso único
POST /v1/tenant/{tenantId}/users/{userId}/login-tokenRetorna um token de uso único (válido por 60 segundos) vinculado ao usuário, ao ambiente e à organização, além de um url. Redirecione o navegador do usuário para essa URL, e ele acessará o ProcessMind com a própria sessão: sem link por e-mail e sem representação. Opcionalmente, envie um path no corpo da solicitação para criar um link direto para uma página específica. A chave precisa ter o escopo sessions, e só é possível criar um usuário para um ambiente que a chave esteja autorizada a atender.
A geração de tokens é auditada, tem limites de uso rigorosos e é bloqueada imediatamente quando a chave é desativada ou o usuário perde o acesso. O token é retornado uma única vez e nunca é registrado em logs.
Tópicos relacionados
- Visão geral da API: como fazer chamadas de API.
- Referência da API: documentação dos endpoints.