Documentação · API
Base URL
https://alpes24.com/api/desenvolvedor/consultasDetalhes
Códigos de erro
Erros vêm sempre no envelope padrão, com success: false, um error curto e uma message explicativa.
| HTTP | error | O que aconteceu |
|---|---|---|
| 200 | Sem resultado | A consulta funcionou mas a fonte não retornou dados. Não é cobrada. |
| 400 | Validação Falhou | Algum parâmetro está em formato inválido (CPF, CEP, nome, etc.). |
| 400 | Formato Inválido | Campo com formato incorreto — ex.: cpfParcial com caracteres não numéricos. |
| 401 | Não Autorizado | Chave de API ausente ou inválida no cabeçalho Authorization. |
| 403 | Assinatura Inativa | Não há assinatura ativa na conta. |
| 403 | Plano sem Acesso API | Seu plano atual não permite integração via API. |
| 403 | Módulo Bloqueado no Plano | O módulo desse endpoint não está liberado para a API no seu plano. |
| 403 | Limite Não Configurado | Não há cota configurada para esse módulo no seu plano. |
| 403 | Limite Esgotado | A cota diária do módulo acabou e a 'Consulta adicional via API' está desativada. Ative-a no perfil para cobrar do saldo ao exceder. |
| 403 | Erro Financeiro | Saldo insuficiente para a operação solicitada. |
| 404 | Módulo Inexistente | O módulo requisitado não existe. |
| 403 | Módulo Inativo | O módulo foi desativado e não está disponível para consulta. |
| 503 | Módulo em Manutenção | O módulo está temporariamente em manutenção. Tente novamente mais tarde. |
| 400 | Erro de Execução | Erro inesperado ao processar a requisição. Tente novamente. |