Se você deseja integrar o sistema da sua empresa com o sistema da WEpayments via API, será necessário criar um usuário específico para esse fim, gerar a chave API e configurar a lista de IPs autorizados a utilizar essa chave. Neste artigo, explicamos como realizar esse processo dentro do painel da WEpayments.
Acesso necessário
A criação de usuários para integração via API e a gestão de permissões são ações restritas a usuários com permissão de Moderador. Essa área é sensível e deve ser gerida por representantes legais ou pessoas com procuração formal para atuar em nome dos representantes legais.
Etapa 1: Criar um usuário exclusivo para integração via API
1. Acesse o painel da WEpayments com um usuário moderador.
2. No menu lateral, clique em Configurações > Controle de Acesso.
3. Clique em Criar usuário.
4. Preencha os dados do usuário com informações voltadas exclusivamente à integração. Exemplo:
- Nome de usuário: API - Nome do Merchant
- E-mail:** api.nomedomerchant@seudominio.com
5. Selecione a empresa correspondente e salve o usuário.
Esse usuário não deve ser utilizado para login humano, pois pode ser excluído se estiver vinculado a um colaborador que venha a deixar a empresa. O ideal é que seja criado unicamente para uso técnico, voltado à integração.
Etapa 2: Atribuir permissões ao usuário API
Após salvar o usuário:
1. Localize o usuário recém-criado e clique sobre ele.
2. Na seção de permissões, marque as funcionalidades que a API poderá executar, como poe exemplo:
- Criar cobranças (payin)
- Criar pagamentos (payout)
- Visualizar extrato
- Inserir documentos KYC
- Outras permissões compatíveis com as ações da integração desejada
3. Salve as alterações.
Etapa 3: Gerar a chave API
Com o usuário configurado:
1. Na tela de edição do usuário, localize a seção Chave API.
2. Clique em Gerar chave API.
3. Copie e armazene essa chave em local seguro.
4. Insira essa chave no seu sistema para que ele possa se comunicar com a WEpayments via API.
Etapa 4: Inserir IPs permitidos para uso da API
Ainda dentro do perfil do usuário API:
1. Localize a seção Lista de IPs permitidos.
2. Adicione os IPs que serão utilizados pelo seu sistema para comunicação via API.
3. Salve as alterações.
Apenas os IPs informados nessa lista poderão fazer chamadas utilizando a chave API, como medida de segurança para evitar acessos indevidos.
Considerações finais
Recomendamos que o gerenciamento desses acessos seja feito com cautela, apenas por pessoas autorizadas.
Em caso de mudanças na infraestrutura do seu sistema, lembre-se de atualizar os IPs permitidos.
A chave API e as permissões atribuídas determinam o que o seu sistema poderá ou não executar via integração.
Se tiver dúvidas ou precisar de apoio, entre em contato com o nosso time de Suporte.
Palavras-chave: Criar chave API; Gerar chave API; Adicionar IP; IPs.