Pular para o conteúdo principal

Suporte

Use esta página como checklist antes de ativar a integração e como referência ao abrir chamados com a ValePix.

Checklist de integração

  • API token recebido por canal seguro.
  • API token autorizado confirmado.
  • product_id obtido em Listar produtos.
  • benefit_id obtido pela rota de benefícios.
  • situation obtida pela rota de situações de colaboradores.
  • Chamada de listagem validada.
  • Criação individual validada.
  • Busca por employee_id validada.
  • Atualização validada.
  • Remoção ou desativação validada.
  • Upload de lote validado com arquivo pequeno.
  • Listagem e commit de lote validados.
  • Datas enviadas em YYYY-MM-DD.
  • Sistema não registra token completo em logs.
  • Sistema mascara CPF, telefone e demais dados pessoais em logs operacionais.

Antes de ativar

Confirme com a ValePix:

  • Token ativo e autorizado.
  • Benefícios disponíveis para cadastro via API.
  • Volume esperado de chamadas.
  • Janela inicial de operação assistida, se aplicável.

Segurança operacional

  • Armazene tokens em cofre de segredos.
  • Restrinja acesso por ambiente e serviço.
  • Não inclua tokens em repositórios, planilhas, prints ou tickets.
  • Não exponha payloads com dados pessoais sem mascaramento.
  • Rotacione tokens quando houver troca de fornecedor, suspeita de exposição ou encerramento de contrato.
  • Revogue tokens que não estejam mais em uso.

Como abrir um chamado

Inclua o máximo de contexto técnico sem expor segredos:

InformaçãoExemplo seguro
Método e endpointGET /api/v1/valepix/employees ou POST /api/v1/valepix/employees
Horário2026-05-08 14:30 America/Sao_Paulo
Código HTTP400
Corpo de erroJSON retornado pela API
IDs relacionadosIDs necessários para diagnóstico
PayloadDados pessoais mascarados

Não envie:

  • API token completo.
  • CPF real sem mascaramento.
  • Telefone real sem mascaramento.
  • Dumps de banco, planilhas integrais ou arquivos com dados sensíveis.

Exemplo de payload mascarado

{
"benefit_id": "00000000-0000-4000-8000-000000000030",
"name": "Maria E.",
"document": "***",
"email": "m***@empresa.test",
"phone": "***",
"birth_date": "1990-05-20",
"cbo": "4110-05",
"situation": "active",
"admission_date": "2024-02-01"
}

Referências rápidas

TemaPágina
Base URLBase URL
QuickstartQuickstart
API tokensAPI tokens
ProdutosProdutos
BenefíciosBenefícios
SituaçõesSituações de colaboradores
ErrosErros