> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vaulterp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Autenticação na API do Vault ERP: Guia de API Keys

> Autentique suas requisições na API do Vault ERP usando chaves de API no header Authorization. Aprenda a gerar e gerenciar suas chaves.

Todas as requisições à API do Vault ERP precisam ser autenticadas. A autenticação é feita via **API key** — uma chave secreta que você gera no painel do Vault ERP e inclui no header `Authorization` de cada chamada. Não há cookies, sessões ou OAuth envolvidos: cada requisição é autenticada de forma independente.

## Gerando sua API Key

As chaves de API são criadas diretamente no painel do Vault ERP, em [**Configurações → Integrações → API**](https://docs.vaulterp.com.br/settings/integrations.md).

Para gerar uma nova chave:

**1. Acesse as configurações de integração**

No menu lateral do Vault ERP, navegue até **Configurações → Integrações → API**.

**2. Crie uma nova chave**

Clique em **"Nova API Key"**, dê um nome descritivo à chave (ex.: `Loja WooCommerce`, `Integração Bling`) e selecione as permissões necessárias.

**3. Copie e guarde a chave com segurança**

A chave completa é exibida **apenas uma vez** no momento da criação. Copie-a imediatamente e armazene em um gerenciador de segredos (como AWS Secrets Manager, HashiCorp Vault ou variáveis de ambiente protegidas). Não será possível visualizá-la novamente.

## Usando sua API Key

Inclua sua chave em todas as requisições através do header `Authorization`, no formato `Bearer`:

```bash theme={null}
curl https://api.vault-erp.com/v1/watches \
  -H "Authorization: Bearer seu_api_key_aqui" \
  -H "Accept: application/json"
```

Para requisições com corpo (POST, PATCH), adicione também o header `Content-Type`:

```bash theme={null}
curl -X POST https://api.vault-erp.com/v1/watches \
  -H "Authorization: Bearer seu_api_key_aqui" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"brand": "Rolex", "model": "Submariner Date", ...}'
```

> [!WARNING]
>
> Nunca exponha sua API key em código client-side (JavaScript rodando no navegador), repositórios públicos no GitHub/GitLab, arquivos de log ou qualquer lugar de acesso não controlado. Qualquer pessoa com sua chave tem acesso completo à sua conta, dentro das permissões configuradas. Se uma chave for exposta acidentalmente, revogue-a imediatamente no painel e gere uma nova.

## Erros de Autenticação

### 401 Unauthorized

Retornado quando a API key está ausente, malformada ou foi revogada.

```json theme={null}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "No valid API key provided. Include your key in the Authorization: Bearer header.",
    "request_id": "req_abc123"
  }
}
```

Causas comuns:

* Header `Authorization` não incluído na requisição
* Formato incorreto — use `Bearer sua_chave`, não apenas a chave sozinha
* Chave revogada no painel do Vault ERP

### 403 Forbidden

Retornado quando a API key é válida, mas não possui permissão para executar a operação solicitada. Por exemplo, uma chave com acesso somente leitura tentando criar ou excluir recursos.

```json theme={null}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Your API key does not have permission to perform this action.",
    "request_id": "req_def456"
  }
}
```

Para resolver, verifique as permissões associadas à chave em **Configurações → Integrações → API** e ajuste conforme necessário.

## Boas Práticas

> [!TIP]
>
> Crie uma API key separada para cada integração, com um nome descritivo (ex.: `E-commerce Site`, `Automação Zapier`, `ERP Externo`). Isso facilita a auditoria de acessos, permite revogar apenas a chave comprometida em caso de incidente e mantém o princípio do menor privilégio — cada integração recebe somente as permissões de que realmente precisa.

Revise periodicamente as chaves ativas em **Configurações → Integrações → API** e revogue qualquer chave que não esteja mais em uso.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.