Tokens de API | Procurize.AI#
Genere, gerencie e use tokens de API para acesso programático seguro ao seu workspace Procurize.AI.
Aplica‑se a: Dashboard Procurize.AI → Configurações → Tokens
Disponível nos: planos Business & Enterprise
Função requerida: Administrador ou Manutenção
Visão geral#
Tokens de API possibilitam acesso programático seguro à plataforma Procurize.AI. Você pode usar os tokens para integrar o Procurize.AI aos seus sistemas internos, automatizar fluxos de trabalho ou criar aplicações personalizadas sobre a plataforma.
Características principais:
- Os tokens herdam todas as permissões do usuário que os criou
- Os tokens são de escopo organizacional – não é necessário especificar
orgnas chamadas de API - É possível gerar tokens ilimitados
- Os tokens podem ter datas de expiração ou serem definidos para nunca expirar
- Os tokens podem ser desativados e posteriormente reativados conforme necessário
🔒 Nota de segurança: O Procurize.AI não armazena o valor do token – apenas seu hash. Você deve copiar e salvar o token imediatamente após a geração. Ele não será exibido novamente.
Acessando o Painel de Gerenciamento de Tokens#
- Navegue até a aba Dashboard → Configurações → Tokens.
- O painel de gerenciamento de tokens exibe seus tokens pessoais associados à organização atual.
Permissão necessária: Apenas usuários com funções Administrador ou Manutenção podem acessar este painel. Para definições detalhadas de funções, veja Visão geral de permissões .
Gerando um Novo Token#
Insira um Nome para identificar o propósito do token.
Selecione um período de expiração:
- 1 mês
- 3 meses
- 1 ano
- Sem expiração (validade ilimitada)
Clique em “Gerar”.
Importante – Copie o Token Imediatamente#
Após a geração, o valor do token é exibido uma única vez – copie‑o e armazene‑o de forma segura (ex.: em um gerenciador de senhas ou variável de ambiente).
⚠️ Você não poderá visualizar o valor do token novamente. O Procurize.AI armazena apenas um hash seguro para verificação. Se você perder o token, deve revogá‑lo e gerar um novo.
Gerenciando Tokens Existentes#
O painel Tokens exibe uma lista de todos os tokens gerados com:
- Nome
- Sufixo
- Data de criação
- Data de expiração (ou “-”)
- Status: Ativo ou Inativo
Desativando / Reativando um Token#
- Desativar – desativa temporariamente o token. Você pode reativá‑lo mais tarde quando necessário.
- Reativar – restaura um token previamente desativado ao status ativo.
💡 A desativação é útil para suspender temporariamente integrações sem excluir o token.
Revogando um Token#
- Revogar – exclui permanentemente o token. Esta ação não pode ser revertida.
- Se você perder um token, revogue‑o imediatamente e gere um novo.
Usando um Token de API#
URL Base & Autenticação#
| Parâmetro | Valor |
|---|---|
| URL Base | https://api.procurize.com |
| Método de autenticação | Token de API via cabeçalho |
| Cabeçalho | X-API-Key: <SEU_TOKEN_API> |
Exemplo de Requisição (cURL)#
curl -X GET "https://api.procurize.com/v1/documents" \
-H "X-API-Key: SEU_TOKEN_API"
🧠 Nenhum ID de organização é necessário – o token está vinculado à sua organização, portanto a API resolve o contexto automaticamente.
Regras Importantes de Segurança & Uso#
| Regra | Explicação |
|---|---|
| Permissões do token | O token tem exatamente as mesmas permissões do usuário que o criou. Se a função do usuário mudar, as permissões do token são atualizadas consequentemente. |
| Vinculação à organização | Os tokens estão vinculados à organização do criador. Você não pode usar um token em várias organizações. |
| Visibilidade do token | O valor do token é exibido apenas uma vez. Guarde‑o imediatamente. O Procurize.AI armazena apenas um hash. |
| Tokens expirados | Tokens expirados são desativados automaticamente e não podem ser usados. Gere um novo token se necessário. |
Solução de Problemas#
| Problema | Solução |
|---|---|
| Erro “Chave de API inválida” | Verifique se o token foi copiado corretamente (sem espaços extras). Confirme que o token ainda está ativo e não expirou. |
| Token não funciona após mudança de função | As permissões do token são atualizadas para corresponder à função atual do usuário. Se o usuário perdeu permissões, o token também as perde. |
| Token perdido | Revogue o token perdido e gere um novo. |
| Limite de taxa | Limites de taxa da API se aplicam conforme seu plano. Verifique os cabeçalhos X-RateLimit-* na resposta. |
Tópicos Relacionados#
- Visão geral de permissões – definições detalhadas de funções
- Planos de Preços – quais planos incluem acesso à API
- Referência da API REST – documentação detalhada dos endpoints