Guide

Autenticação

A autenticação da API da V8 Digital é realizada por meio do protocolo OAuth 2.0. Para isso, é necessário enviar os parâmetros apropriados no corpo da requisição no formato application/x-www-form-urlencoded. A seguir, detalhamos os passos necessários para obter o token de acesso.

Parâmetros Requeridos

A requisição de autenticação deverá ser realizada via POST com os seguintes parâmetros no corpo da solicitação:

  • grant_type: password
    Tipo de concessão de acesso. Para autenticação via senha, sempre defina como password.

  • username: <email>
    O e-mail de usuário que foi fornecido para o processo de integração.

  • password: <senha>
    A senha associada ao username fornecido.

  • audience: <fornecido_por_email>
    O valor de audience será fornecido por e-mail após solicitação à sua gerente comercial.

  • scope: offline_access
    O escopo fixo para permitir o acesso offline. Este parâmetro deve ser sempre enviado com o valor offline_access.

  • client_id: <fornecido_por_email>
    O client_id será fornecido por e-mail pela V8 Digital e deve ser utilizado como identificador da sua aplicação.

Processo de Obtenção das Credenciais

  1. Solicitação de Credenciais:
    Para obter o client_id e o audience, entre em contato com sua gerente comercial e solicite as informações necessárias para o processo de autenticação.

  2. Solicitação Técnica:
    Envie um e-mail para ti@v8sistema.online, incluindo as informações solicitadas e os dados fornecidos pela sua gerente comercial. O suporte técnico da V8 Digital processará sua solicitação e fornecerá as credenciais de autenticação.

Exemplo de Requisição de Autenticação

A seguir, um exemplo de como a requisição de autenticação deve ser realizada via HTTP POST:


POST /oauth/token HTTP/1.1
Host: api.v8digital.com
Content-Type: application/x-www-form-urlencoded

grant_type=password&username=seu_email@dominio.com&password=sua_senha&audience=audience_value&scope=offline_access&client_id=client_id_value

Resposta de Autenticação

Se a autenticação for bem-sucedida, a resposta conterá o token de acesso e informações adicionais, como o tipo de token e a duração de validade. A resposta será similar ao seguinte formato JSON:


{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 86400,
  "scope": "offline_access"
}

O access_token gerado deverá ser incluído no header Authorization de todas as requisições subsequentes à API.