Ambientes

A API da Nuvende opera em dois ambientes distintos: Homologação e Produção. Cada ambiente possui uma URL específica e deve ser utilizado de acordo com o estágio da integração.

Ambientes Disponíveis

Diferença Entre os Ambientes

Homologação (api-h.nuvende.com.br)

• Ambiente utilizado para testes e validações
• Permite simular requisições sem impacto em dados reais
• Tokens de acesso e credenciais de teste podem ser diferentes dos de produção

Produção (api.nuvende.com.br)

• Ambiente oficial para operações reais
• Todas as transações e requisições são efetivas e impactam os dados de produção
• Exige credenciais de produção, que devem ser armazenadas com segurança

Como Escolher o Ambiente Correto

• Para testes e desenvolvimento, utilize sempre a URL de homologação (api-h.nuvende.com.br)
• Para operações reais, utilize a URL de produção (api.nuvende.com.br)

⚠️ Atenção: Antes de migrar para o ambiente de produção, valide todas as integrações no ambiente de homologação para garantir o funcionamento correto.

Solicitação de Credenciais de Acesso

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.

Como Solicitar as Credenciais

Os clientes podem obter suas credenciais através dos seguintes canais:

1. Suporte Técnico:
   Envie um e-mail para [email protected] solicitando as credenciais de acesso. No e-mail, inclua:
   • Nome da empresa
   • Nome do responsável pela integração
   • Finalidade do uso da API
   • Produtos ou serviços que pretende utilizar
2. Canal de Vendas:
   Caso já tenha um contato comercial estabelecido, entre em contato diretamente com o canal de vendas do seu cliente para solicitar as credenciais

Após a solicitação, a equipe de suporte ou o canal de vendas analisará a requisição e fornecerá as credenciais necessárias para integração.

Importante

• As credenciais são sensíveis e sigilosas. Armazene-as com segurança e não as compartilhe com terceiros
• Caso suspeite de comprometimento das suas credenciais, entre em contato imediatamente com o suporte para revogação e emissão de novas credenciais
• O uso da API está sujeito às políticas de segurança e conformidade da Nuvende

Autenticação

A API utiliza o fluxo de client credentials para autenticação. O acesso aos endpoints protegidos requer um token de acesso, que deve ser enviado no cabeçalho Authorization.

• Login: Gera um token de acesso válido por um período determinado
• Refresh Token: Renova um token expirado sem a necessidade de um novo login
• Logout: Invalida um token de acesso ativo
• Informações do Usuário: Recupera detalhes sobre o cliente autenticado

Segurança e Acesso

• Autenticação: Todas as requisições protegidas exigem um token de acesso válido
• Scopes: Os tokens de acesso concedem permissões específicas conforme os scopes definidos
• Uso de HTTPS: Todas as requisições devem ser feitas via HTTPS para garantir a segurança dos dados

Códigos de Resposta