1. API Parceiros
Parceiros
  • API Parceiros
    • Autenticação
      POST
    • Cadastrar pessoa jurídica
      POST
    • Cadastrar pessoa física
      POST
    • Listar vouchers disponíveis
      GET
    • Ativar voucher
      POST
    • Consultar status empresa
      GET
    • Listar empresas
      GET
    • Ativar ou desativar empresa
      PATCH
    • Atualizar pessoa jurídica
      PUT
    • Atualizar pessoa física
      PUT
  1. API Parceiros

Autenticação

POST
https://auth.parceiros.vhsys.com.br/v1/authentication
A rota de autenticação é responsável por gerar um token de acesso JWT com base no nome de usuário e senha fornecidos pelo usuário. Esse token é necessário para o acesso a todas as demais rotas disponíveis na API.
Ao realizar uma requisição para a rota de autenticação, o usuário deve fornecer as credenciais username e password no cabeçalho Authorization, como parâmetros. Essas informações são então validadas, e a API gera um token JWT exclusivo para o respectivo usuário. Esse token, composto por uma sequência de caracteres alfanuméricos, atua como um identificador e autenticador do usuário em requisições subsequentes. Portanto, é importante que o token seja enviado juntamente com as próximas requisições, no cabeçalho Authorization, utilizando o formato Bearer.

Requisição

Authorization
Envie suas requisições HTTP com um cabeçalho
Authorization
que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password
Exemplo:
Authorization: Basic *****************

Respostas

🟢200Success
application/json
Bodyapplication/json

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://auth.parceiros.vhsys.com.br/v1/authentication' \
--header 'Authorization: Basic <encoded-value>'
Response Response Example
200 - Success
{
    "token": "*********",
    "type": "bearer",
    "expiration": 3600
}
Modificado em 2025-04-29 17:45:09
Próxima página
Cadastrar pessoa jurídica
Built with