Chaves de Teste

Para obter os tokens de acesso à API, o cliente deve solicitar as credenciais Client ID e Client Secret. Essas credenciais são utilizadas na autenticação via Basic Auth para gerar um token de acesso válido.

Credenciais Necessárias

Client ID e Client Secret

Credenciais principais para autenticação Basic Auth.

{
  "client_id": "seu_client_id_aqui",
  "client_secret": "seu_client_secret_aqui",
  "environment": "homologacao"
}

Access Token

Token gerado após autenticação bem-sucedida.

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "token_type": "bearer",
  "expires_in": 3600
}

Como Solicitar as Credenciais

Os clientes podem obter suas credenciais através dos canais de atendimento, da mesma forma que obtem as credenciais de produção

Configuração das Chaves

Variáveis de Ambiente

Configure as chaves no seu projeto:

# .env (Desenvolvimento)
NUVENDE_ENV=homologacao
NUVENDE_CLIENT_ID=seu_client_id_aqui
NUVENDE_CLIENT_SECRET=seu_client_secret_aqui
NUVENDE_BASE_URL=https://api-h.nuvende.com.br

Configuração por Ambiente

// config/nuvende.js
const config = {
  homologacao: {
    clientId: process.env.NUVENDE_CLIENT_ID,
    clientSecret: process.env.NUVENDE_CLIENT_SECRET,
    baseUrl: 'https://api-h.nuvende.com.br'
  },
  production: {
    clientId: process.env.NUVENDE_PROD_CLIENT_ID,
    clientSecret: process.env.NUVENDE_PROD_CLIENT_SECRET,
    baseUrl: 'https://api.nuvende.com.br'
  }
};

Fluxo de Autenticação

1. Obter Access Token (Basic Auth)

curl -X POST https://api-h.nuvende.com.br/api/v2/auth/login \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Authorization: Basic YjhhMDc1MTgtZDBjZS00ODk3LThlOGUtM2VjOWM1NmMyNjMyOnlvdXItc2VjcmV0LWhlcmU=" \
  --data-urlencode "grant_type=client_credentials" \
  --data-urlencode "scope=cob.read cob.write webhooks.read webhooks.write pix.read pix.write contas.read contas.saldo.read contas.extrato.read contas.chaves.read kyc.background-check.natural-person kyc.background-check.legal-person"

2. Resposta de Sucesso

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "token_type": "bearer",
  "expires_in": 3600
}

3. Usar o Token

curl -X GET https://api-h.nuvende.com.br/api/v2/protected-resource \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." \
  -H "Content-Type: application/json"

Escopos Disponíveis

A API da Nuvende oferece os seguintes escopos para controle de acesso. Solicite apenas os necessários ao caso de uso.

KYC (Know Your Customer)

Cobranças Pix (recebimento)

Pagamentos Pix (envio / cash-out)

Conta

Webhooks

Estabelecimentos, terminais e transações

Detalhes do fluxo de login: Autenticação — Login.

Autenticação Basic Auth

A autenticação é feita via Basic Auth, onde o Client ID e Client Secret são codificados em Base64 e enviados no cabeçalho da requisição.

Como Gerar o Header Basic Auth

// Exemplo em JavaScript
const clientId = 'seu_client_id';
const clientSecret = 'seu_client_secret';
const credentials = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');
const authHeader = `Basic ${credentials}`;

// Resultado: Basic YjhhMDc1MTgtZDBjZS00ODk3LThlOGUtM2VjOWM1NmMyNjMyOnlvdXItc2VjcmV0LWhlcmU=