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

# Introdução

> Confira uma breve introdução das APIs da Salvy

Bem-vindo à documentação da API da Salvy! Esta API foi projetada para oferecer uma interface eficiente, segura e robusta para acessar e interagir com os serviços da Salvy. Aqui você encontrará todas as informações necessárias para integrar-se à nossa plataforma e começar a construir soluções incríveis.

## Endereço Base da API

Todas as requisições à API devem ser feitas para o seguinte endereço base:

```
https://api.salvy.com.br
```

Certifique-se de usar HTTPS em todas as suas requisições para garantir a segurança da comunicação.

## Estrutura Geral das Requisições

Nossa API segue os padrões REST e utiliza os seguintes métodos HTTP para operações:

* GET: Para recuperar informações.
* POST: Para criar novos recursos.
* PATCH: Para atualizar recursos existentes.
* DELETE: Para remover recursos.

## Autenticação

A API da Salvy utiliza o método de autenticação baseado em **Bearer Token** para garantir acesso seguro aos seus recursos. Para cada requisição à API, é necessário incluir um token de autenticação válido no cabeçalho HTTP `Authorization`.

### Como obter seu token

Você pode criar e gerenciar suas chaves de API diretamente no dashboard, na página de [API & Webhooks](https://app.salvy.com.br/settings/api). Consulte o guia de [Chaves de API](/api-reference/api-keys) para mais detalhes.

<Warning>
  A chave gerada é exibida apenas uma vez no momento da criação. Copie e guarde-a em um local seguro — ela não poderá ser exibida novamente.
</Warning>

### Formato do Cabeçalho

O token deve ser enviado no seguinte formato:

```
Authorization: Bearer <seu_token>
```

* Substitua `<seu_token>` pelo token fornecido pela Salvy.
* O prefixo `Bearer` é obrigatório e deve ser seguido por um espaço antes do token.

### Exemplo de Requisição

Aqui está um exemplo de requisição usando `curl`:

```bash theme={null}
curl -X GET "https://api.salvy.com/resource" \
-H "Authorization: Bearer abc123def456gh789" \
-H "Content-Type: application/json"
```

### Erros de Autenticação

Se o token não for fornecido ou for inválido, a API retornará um erro com o código de status `HTTP 401 Unauthorized`. Verifique se:

* O token está correto.
* O token não expirou.
* O cabeçalho Authorization segue o formato especificado.