👥 APIs de Clientes
Bem-vindo à documentação de Clientes! Esta seção reúne os guias completos para integração com as APIs de consulta e gerenciamento de informações de clientes em estabelecimentos lojistas.
📚 Documentos Disponíveis
🏪 Clientes Lojista
API REST para consulta de informações de clientes em estabelecimentos físicos. Permite acessar dados cadastrais, cartões, portadores e contatos.
| Funcionalidade | Descrição |
|---|---|
| Consultar Dados Cadastrais | Acessa informações completas do cliente |
| Consultar Cartões | Obtém dados de cartões, limites e situação |
| Consultar Contatos | Acessa telefones e e-mails cadastrados |
| Consultar Endereços | Visualiza endereços do cliente |
| Consultar Portadores | Identifica portadores adicionais vinculados |
Ideal para
Estabelecimentos lojistas que precisam consultar informações de clientes para atendimento, venda ou gestão de cartões no PDV.
🔧 Troubleshooting
Guia de resolução de problemas para todos os endpoints de clientes.
- Erros comuns e suas causas
- Ações recomendadas por endpoint
- Códigos de retorno e mensagens de erro
🛡️ Segurança
| Recurso | Descrição |
|---|---|
| 🔑 Bearer Token (JWT) | Obrigatório em todos os endpoints |
| 🔒 HTTPS/TLS 1.2+ | Todas as requisições devem usar HTTPS |
| 📋 CPF no Header | Identificação do cliente via header cpfCliente |
URLs Base:
| Ambiente | URL |
|---|---|
| Homologação | https://apihml.credsystem.com.br/servicos-lojistas/api/v1 |
| Produção | https://api.credsystem.com.br/servicos-lojistas/api/v1 |
📖 Referência OpenAPI
Para detalhes técnicos completos (schemas, exemplos de payload, tipos de dados), consulte a Especificação OpenAPI.