Documentation Index
Fetch the complete documentation index at: https://support.wepayments.com.br/llms.txt
Use this file to discover all available pages before exploring further.
Este guia fornece um passo a passo sobre como criar um usuário de API, gerar uma chave de API, atribuir permissões e configurar endereços IP permitidos para uma integração segura via API.
Acesso necessário
A criação de usuários para integração via API e o gerenciamento de permissões são ações restritas a usuários com permissão de Moderador.
| Requisito | Detalhes |
|---|
| Nível de permissão | Moderador |
| Quem deve ter | Representantes legais ou pessoas com procuração formal |
| Por quê | Esta área é sensível e deve ser gerenciada apenas por pessoas autorizadas |
⚠️ Por razões de segurança, a permissão de Moderador deve ser concedida apenas a representantes legais da empresa ou pessoas autorizadas por procuração legal.
Configuração passo a passo da autenticação de API
Passo 1: Criar um usuário dedicado para integração via API
| Ação | Instruções |
|---|
| 1. Acessar o Dashboard | Faça login com um usuário Moderador |
| 2. Navegar | Configurações > Controle de Acesso |
| 3. Criar usuário | Clique em “Criar Usuário” |
| 4. Preencher os dados | Use informações específicas para fins de integração (pode ser um e-mail fictício) |
| 5. Exemplo | Nome de usuário: API - Nome do Merchant / E-mail: api.nomedomerchant@suaempresa.com |
| 6. Associar empresa | Selecione a empresa correspondente e salve |
⚠️ Importante: Este usuário não deve ser utilizado para login humano. Ele pode ser excluído se estiver vinculado a um funcionário que sair da empresa. Crie-o exclusivamente para uso técnico/integração.
Passo 2: Atribuir permissões ao usuário de API
| Ação | Instruções |
|---|
| 1. Localizar o usuário | Encontre o usuário recém-criado na lista |
| 2. Abrir o usuário | Clique no usuário para editar |
| 3. Selecionar permissões | Marque as funcionalidades que a API pode executar |
| 4. Salvar | Salve as alterações |
Permissões disponíveis (exemplos)
| Permissão | O que permite |
|---|
| Criar cobranças (payin) | A API pode criar cobranças via PIX, boleto e cartão de crédito |
| Criar pagamentos (payout) | A API pode enviar pagamentos a beneficiários |
| Visualizar extrato | A API pode consultar saldo e extratos de transações |
| Inserir documentos KYC | A API pode enviar documentos de conformidade |
| Outras permissões | Dependendo do seu contrato e produto |
💡 As permissões disponíveis dependem do tipo de produto que você adquiriu.
Acesso necessário
A criação de usuários para integração via API e o gerenciamento de permissões são ações restritas a usuários com permissão de Moderador.
| Requisito | Detalhes |
|---|
| Nível de permissão | Moderador |
| Quem deve ter | Representantes legais ou pessoas com procuração formal |
| Por quê | Esta área é sensível e deve ser gerenciada apenas por pessoas autorizadas |
⚠️ Por razões de segurança, a permissão de Moderador deve ser concedida apenas a representantes legais da empresa ou pessoas autorizadas por procuração legal.
Configuração passo a passo da autenticação de API
Passo 1: Criar um usuário dedicado para integração via API
| Ação | Instruções |
|---|
| 1. Acessar o Dashboard | Faça login com um usuário Moderador |
| 2. Navegar | Configurações > Controle de Acesso |
| 3. Criar usuário | Clique em “Criar Usuário” |
| 4. Preencher os dados | Use informações específicas para fins de integração (pode ser um e-mail fictício) |
| 5. Exemplo | Nome de usuário: API - Nome do Merchant / E-mail: api.nomedomerchant@suaempresa.com |
| 6. Associar empresa | Selecione a empresa correspondente e salve |
⚠️ Importante: Este usuário não deve ser utilizado para login humano. Ele pode ser excluído se estiver vinculado a um funcionário que sair da empresa. Crie-o exclusivamente para uso técnico/integração.
Passo 2: Atribuir permissões ao usuário de API
| Ação | Instruções |
|---|
| 1. Localizar o usuário | Encontre o usuário recém-criado na lista |
| 2. Abrir o usuário | Clique no usuário para editar |
| 3. Selecionar permissões | Marque as funcionalidades que a API pode executar |
| 4. Salvar | Salve as alterações |
Permissões disponíveis (exemplos)
| Permissão | O que permite |
|---|
| Criar cobranças (payin) | A API pode criar cobranças via PIX, boleto e cartão de crédito |
| Criar pagamentos (payout) | A API pode enviar pagamentos a beneficiários |
| Visualizar extrato | A API pode consultar saldo e extratos de transações |
| Inserir documentos KYC | A API pode enviar documentos de conformidade |
| Outras permissões | Dependendo do seu contrato e produto |
💡 As permissões disponíveis dependem do tipo de produto que você adquiriu.
Passo 3: Gerar a chave de API
| Ação | Instruções |
|---|
| 1. Localizar a seção de Chave de API | Na tela de edição do usuário |
| 2. Clicar em “Criar Chave de API” | Uma nova tela será aberta |
| 3. Inserir endereços IP | |
| 4. Fornecer o código 2FA | O código de autenticação de dois fatores é obrigatório |
| 5. Copiar a chave | A chave é exibida apenas uma vez – no momento da criação |
| 6. Armazenar com segurança | Cole e guarde a chave em um local seguro |
| 7. Inserir no seu sistema | Use esta chave para comunicação via API com a WEpayments |
| 6. Armazenar com segurança | Cole e guarde a chave em um local seguro |
| 7. Inserir no seu sistema | Use esta chave para comunicação via API com a WEpayments |
⚠️ Nota de segurança: Para sua segurança, solicitamos o código de autenticação de dois fatores para criar uma chave de API, excluí-la e adicionar endereços IP à lista de permitidos.
Acesse “Preferências” > “Controle de Acesso” > Clique no usuário > Vá ao final da página > “Criar Chave de API”\
Passo 4: Configurar endereços IP permitidos
| Ação | Detalhes |
|---|
| Por que é obrigatório | Somente os IPs listados podem fazer chamadas usando a chave de API – impede acesso não autorizado |
| Como adicionar | Durante a criação da chave de API ou ao editar o usuário |
| Atualize quando necessário | Lembre-se de atualizar os IPs permitidos se a infraestrutura do seu sistema mudar |
Resumo: checklist de autenticação de API
| Passo |
|---|
| ✅ Criar usuário dedicado para API (não para login humano) |
| ✅ Atribuir permissões adequadas (payin, payout, extratos, etc.) |
| ✅ Gerar chave de API (copiar e armazenar imediatamente) |
| ✅ Configurar endereços IP permitidos |
| ✅ Ativar a autenticação de dois fatores para o usuário do Dashboard |
| ✅ Armazenar a chave de API com segurança no seu sistema |
Boas práticas de segurança
| Prática | Por quê |
|---|
| Use um usuário dedicado para API | Evita perda de acesso caso um funcionário saia da empresa |
| Minimize as permissões | Conceda apenas o que a API precisa |
| Rotacione as chaves de API periodicamente | Reduz o risco de chaves comprometidas |
| Revise o whitelist de IP regularmente | Remova IPs desatualizados ou não utilizados |
| Monitore o uso da API | Detecte padrões incomuns |
| Nunca compartilhe chaves de API | Trate-as como senhas |
