> ## 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

> A API da Salvy permite integrar seus sistemas aos produtos da plataforma. Nesta documentação você encontrará tudo o que precisa para autenticar suas requisições, entender os ambientes disponíveis e começar a utilizar os endpoints.

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
```

Os endpoints da versão 3 ficam sob o caminho `/api/v3/`. Certifique-se de usar HTTPS em todas as suas requisições para garantir a segurança da comunicação.

A Salvy oferece os ambientes de produção e sandbox, ambos neste mesmo endereço base. O ambiente é definido pela chave de API utilizada. Saiba mais em [Ambientes](/api-reference/v3/environments).

## Autenticação

Para cada requisição 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`.

### Chaves de empresa e de organização

A Salvy tem dois tipos de chave, e o tipo define a abrangência da chave:

* **Chave de empresa**: acessa os recursos de **uma empresa**. Criada nas configurações da empresa.
* **Chave de organização**: acessa os recursos de **todas as empresas** da sua organização, com uma única chave. Criada por administradores nas configurações da organização.

Consulte o guia de [Chaves de API](/api-reference/v3/api-keys) para criar cada tipo e entender quando usar cada um.

### Como obter seu token

Você pode criar e gerenciar suas chaves de API diretamente no dashboard: chaves de empresa em [API & Webhooks](https://app.salvy.com.br/settings/api) e chaves de organização em [Configurações da organização > API](https://app.salvy.com.br/organization/settings/api).

<Warning>
  A chave é exibida apenas uma vez. Copie e guarde-a em um local seguro antes de
  fechar a janela.
</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 Chave de empresa theme={null}
curl -X GET "https://api.salvy.com.br/api/v3/cost-centers" \
-H "Authorization: Bearer salvy_prod_abc123def456gh789" \
-H "Content-Type: application/json"
```

```bash Chave de organização theme={null}
curl -X GET "https://api.salvy.com.br/api/v3/cost-centers" \
-H "Authorization: Bearer salvy_org_prod_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.