Autenticação
🔐 Autenticação na API ENSPACE
x-api-key. Este guia detalha todo o processo de autenticação.Fluxo de Autenticação
📋 Headers Obrigatórios
Header de Workspace
en-workspace é obrigatório apenas em endpoints que operam no contexto de um workspace específico:💡 Dica: Cada endpoint na documentação indica claramente se o header en-workspaceé obrigatório ou não.
🔑 Gerando seu Token de API
Pré-requisitos
Passo a Passo
1️⃣ Acessar o ENSPACE
1.
2.
3.
2️⃣ Acessar Configurações de Usuário
1.
2.
3️⃣ Navegar até a Aba Dev
1.
2.
4️⃣ Criar Novo Token
1.
2.
| Campo | Descrição | Exemplo |
|---|---|---|
| Descrição | Nome identificador | "Integração ERP", "App Mobile" |
| Expiração | Prazo de validade | 1M, 6M, 1y, never |
| Escopos | Permissões do token | ☑️ read ☑️ write ☐ delete |
| Workspaces | Workspaces autorizados | ☑️ Workspace A ☑️ Workspace B |
3.
5️⃣ Salvar o Token
en.ushcHQHcREdPpe3ZKFCSfAASFE5VawTwTH (exemplo)🚀 Usando o Token
Configuração por Ambiente
.env
# Para API Global
ENSPACE_API_KEY=en.ushcHQHcREdPpe3ZKFCSfAASFE5VawTwTH
ENSPACE_API_URL=https://api.leif.enspace.io
ENSPACE_WORKSPACE_ID=ws-123
# Para API Dedicada (exemplo)
# ENSPACE_API_URL=https://acme.api.enspace.ioExemplos de Uso
JavaScript
cURL
Python
🔄 Tokens Multi-Workspace
❌ Problemas Comuns
Header de Workspace Ausente
{
"statusCode": 400,
"error": "Bad Request",
"message": "Missing required header: en-workspace"
}en-workspace em todas as requisições.Token Inválido
{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or missing API key"
}Workspace Não Autorizado
{
"statusCode": 403,
"error": "Forbidden",
"message": "Token not authorized for this workspace"
}🔒 Boas Práticas
✅ FAÇA
❌ NÃO FAÇA
📞 Suporte
1.
2.
3.
4.