Orientações iniciais
Nossa API de integração está implementada em conformidade com o princípio de design REST. Esta API possui recursos orientados a URLs, com códigos HTTP para indicar erros. Nós utilizamos funcionalidades HTTP nativas, como o verbo de ação GET para operações de leitura, bem como modelo de autenticação baseado em token.
Toda a comunicação deve ser criptografada via SSL/HTTPS.
A aplicação cliente deve enviar um cabeçalho de Autorização HTTP contendo o token gerado a cada solicitação.
Base URL
https://api-sbx.moneyguard.com.br
https://api.moneyguard.com.br
Formato de dados
- Todas as requisições e respostas utilizam formato JSON
- Content-Type:
application/json - Valores monetários são enviados em reais (ex: 100.50) e retornados da mesma forma
Códigos de Status HTTP
| CODIGO | DESCRIÇÃO |
|---|---|
| 200 | Requisição bem sucedida |
| 201 | Recurso criado com sucesso |
| 400 | Requisição inválida - verifique os parâmetros |
| 401 | Não autorizado - token invalido ou expirado |
| 403 | Acesso negado - IP não autorizado ou requisição inválida |
| 404 | Recurso não encontrado |
| 500 | Erro interno do servidor |
Tratamento de requisições consecutivas
O envio consecutivo de requisições pode causar bloqueio temporário de 30 minutos, com recebimento de mensagem com status 429 – too many quest. Este bloqueio é automático e não pode ser removido manualmente, sendo necessário aguardar o tempo total do mesmo.
Fique atento para não cair nessas validações de segurança:
- Mais de 10 tentativas de autenticação, no período de 5 minutos
- Mais de 50 tentativas de autenticação e consulta de pix collection e pix transfers no período de 1 minuto
Envio excessivo de requisições pode causar bloqueio temporário de 30 minutos, com status 429 – too many requests