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

# Autenticação

> Autentica cada pedido à Aniva Partner API com a tua chave de API de parceiro no cabeçalho x-api-key e mantém a chave fora do código do navegador.

Todos os pedidos à API de parceiros da Aniva devem incluir a tua chave de API de parceiro no cabeçalho de pedido `x-api-key`.

```http theme={null}
x-api-key: your-api-key-here
```

> [!NOTE]
>
> Contacta a Aniva para obteres a tua chave de API. As chaves são emitidas por conta de parceiro.

## Enviar pedidos autenticados

Inclui o cabeçalho `x-api-key` em cada pedido que fizeres à API.

```bash cURL theme={null}
curl https://anivahealth.com/api/v1/locations \
  -H "x-api-key: YOUR_API_KEY"
```

```javascript JavaScript theme={null}
const response = await fetch('https://anivahealth.com/api/v1/locations', {
  headers: {
    'x-api-key': 'YOUR_API_KEY',
  },
});

const data = await response.json();
```

## Respostas de erro

Se o teu pedido não tiver o cabeçalho `x-api-key`, a API responde com `401 Unauthorized`.

```json theme={null}
{
  "error": "This endpoint requires API key authentication"
}
```

Se a chave de API não for válida, a API responde com `401 Unauthorized`.

```json theme={null}
{
  "error": "Invalid API key"
}
```

Se a chave for válida, mas não tiver o scope para o endpoint, a API responde com `403 Forbidden`.

```json theme={null}
{
  "error": "Insufficient permissions: requires appointments_schedule scope"
}
```

Se receberes um destes erros, verifica se:

1. O teu pedido inclui o cabeçalho `x-api-key`.
2. O valor da chave de API está correto e não foi rodado.
3. A tua chave tem o scope que o endpoint exige. Cada endpoint na referência da API indica o seu scope.

> [!WARNING]
>
> Nunca exponhas a tua chave de API em código do lado do cliente ou em repositórios públicos. Trata-a como uma palavra-passe.

Contacta a Aniva para rodar uma chave comprometida ou pedir alterações às permissões da tua chave de API.


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