ValePix Developers
A API ValePix permite que sistemas de RH, ERPs e plataformas parceiras integrem benefícios e colaboradores sem depender do portal. A autenticação é feita com API token enviado no header Authorization.
Esta documentação cobre apenas as rotas públicas para clientes. Use um API token autorizado para acessar as rotas de produtos, benefícios, colaboradores e lotes.
/api/v1/valepix/products
/api/v1/valepix/benefits
/api/v1/valepix/employees/situations
/api/v1/valepix/employees
Base URL
Todas as chamadas públicas usam a base URL:
https://routes.valepix.com.br/api/v1
Autenticação
Todas as chamadas exigem um API token ativo:
Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json
Content-Type: application/json
Para upload de arquivo em lote, use multipart/form-data no lugar de application/json.
Use o API token autorizado no header Authorization.
Rotas disponíveis
| Operação | Método | Rota |
|---|---|---|
| Listar produtos | GET | /api/v1/valepix/products |
| Criar benefício | POST | /api/v1/valepix/benefits |
| Listar benefícios | GET | /api/v1/valepix/benefits |
| Buscar benefício | GET | /api/v1/valepix/benefits/{benefit_id} |
| Atualizar benefício | PUT | /api/v1/valepix/benefits/{benefit_id} |
| Remover benefício | DELETE | /api/v1/valepix/benefits/{benefit_id} |
| Listar situações de colaboradores | GET | /api/v1/valepix/employees/situations |
| Listar colaboradores | GET | /api/v1/valepix/employees |
| Contar colaboradores | GET | /api/v1/valepix/employees/count |
| Criar colaborador | POST | /api/v1/valepix/employees |
| Buscar colaborador | GET | /api/v1/valepix/employees/{employee_id} |
| Atualizar colaborador | PUT | /api/v1/valepix/employees/{employee_id} |
| Remover ou desativar colaborador | DELETE | /api/v1/valepix/employees/{employee_id} |
| Enviar lote | POST | /api/v1/valepix/employees/batch/upload |
| Consultar lote | GET | /api/v1/valepix/employees/batch/{batch_id} |
| Remover itens de lote | DELETE | /api/v1/valepix/employees/batch/{batch_id} |
| Confirmar lote | POST | /api/v1/valepix/employees/batch/{batch_id}/commit |
Formatos importantes
| Campo | Formato |
|---|---|
employee_id, batch_id | UUID retornado pela API |
product_id | Use o id retornado por Listar produtos |
benefit_id | Use o benefit_id da criação de benefício ou o id retornado por Listar benefícios |
situation | Use o campo value retornado por Situações de colaboradores |
document | CPF válido do colaborador, preferencialmente somente números |
phone | Telefone brasileiro válido, preferencialmente somente números |
birth_date | YYYY-MM-DD |
admission_date | YYYY-MM-DD |
Não envie timestamp ISO completo em birth_date ou admission_date. Use somente data, por exemplo 1990-05-20.
Próximos passos
- Configure a base URL em Base URL.
- Revise as regras de API tokens.
- Siga o fluxo completo em Cadastrar colaboradores.
- Faça uma chamada inicial em Quickstart.
- Liste produtos em Produtos.
- Configure benefícios em Benefícios.
- Implemente as rotas de Colaboradores.