Skip to main content
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:
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.

​
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 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 e chaves de organização em Configurações da organização > API.
A chave é exibida apenas uma vez. Copie e guarde-a em um local seguro antes de fechar a janela.

​
Formato do Cabeçalho

O token deve ser enviado no seguinte formato:
  • 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:
Chave de empresa
Chave de organização

​
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.