Clube Certo - Plataforma de descontos, benefícios e vantagens

Login Company

Autentica sua empresa com CNPJ e senha. Armazena o token de empresa na sessão — use antes de qualquer outro endpoint companyAPI.

Login Establishment

Autentica um estabelecimento parceiro com login e senha. Armazena o token de estabelecimento na sessão para uso em verify_user_by_cpf.

Generate User Token

Gera um token de usuário a partir de um CPF de associado. Necessário antes de usar endpoints de Discount e Cashback. Requer login_company primeiro.

Register Associate

Cadastra ou atualiza um associado na empresa. Se o CPF já existir, atualiza os dados. Se não, cria novo. Use fatherCPF para vincular como dependente de um titular. Requer login_company.

List Associates

Lista associados da empresa com filtros opcionais e paginação. Todos os filtros são opcionais e combinados com AND. Requer login_company.

Inactivate Associate

Inativa um associado da empresa pelo CPF. O associado não é excluído — apenas marcado como inativo. Dependentes do titular também são inativados automaticamente. Requer login_company.

Bulk Register Associates

Cadastra ou atualiza múltiplos associados em lote (máx 1000 por requisição). CPFs existentes são atualizados; novos são criados. Erros individuais não impedem o processamento dos demais. Requer login_company.

Bulk Inactivate Associates

Inativa múltiplos associados em lote pelo CPF (máx 1000). Requer login_company.

List Products

Lista os produtos disponíveis para a empresa, incluindo planos de telemedicina. Use para saber quais produtos e planos podem ser atribuídos aos associados. Requer login_company.

Get Appointment Link

Retorna o link de agendamento de telemedicina para o associado. O associado deve estar ativo e ter produto de telemedicina habilitado. Use force=true para forçar a geração de um novo link. Requer login_company.

Get Medical History

Retorna o histórico de consultas e pré-agendamentos de telemedicina do associado. Inclui consultas realizadas (com detalhes médicos e prescrições) e pré-agendamentos pendentes. Requer login_company.

List States

Lista todos os estados brasileiros. Não requer autenticação. Use o campo id para filtrar cidades.

List Cities

Lista cidades de um estado específico. Não requer autenticação. Use list_states para obter o stateId correto.

List Categories

Lista categorias de estabelecimentos disponíveis. Use o id da categoria para filtrar em search_establishments. Requer generate_user_token.

Search Establishments

Busca estabelecimentos com desconto. Modos: por geolocalização (latitude+longitude), por localização (city/state), por nome (term) ou por categoria. Pode combinar filtros. Requer generate_user_token.

Get Establishment

Retorna detalhes completos de um estabelecimento: benefícios, endereço mais próximo, contato, status de favorito. Passe lat/long para calcular distância. Requer generate_user_token.

Get Establishment Addresses

Lista todos os endereços/unidades de um estabelecimento, ordenados por proximidade. Requer generate_user_token.

List Cashback Establishments

Lista estabelecimentos parceiros que oferecem cashback. Inclui percentual mínimo/máximo e prazo de crédito. Requer generate_user_token.

Get Cashback Establishment

Retorna detalhes de um estabelecimento de cashback específico: regras, link de afiliado, percentual e prazo de pagamento. Requer generate_user_token.

Verify User By Cpf

Verifica se um usuário está ativo no Clube Certo e tem direito a benefícios. Usado por estabelecimentos parceiros antes de aplicar desconto. Com detail=true retorna dados mesmo de usuários inativos. Requer login_establishment.

Run Associate Smoke Test

Executa um teste de integração completo para o fluxo de associados: login → cadastra titular → cadastra dependente → lista → inativa. Use CPFs fictícios de teste. Retorna um trace passo-a-passo com resultados e IDs.

Run Telemedicine Smoke Test

Executa teste de integração do fluxo de telemedicina: login → lista produtos → cadastra associado com plano → gera link de agendamento → consulta histórico. Retorna trace passo-a-passo.

Run Discount Cashback Smoke Test

Executa teste de integração do fluxo de Discount e Cashback: login empresa → gera token usuário → busca estabelecimentos com desconto → lista estabelecimentos com cashback. Retorna trace passo-a-passo.