Benefícios

As rotas de benefícios permitem criar, consultar, atualizar e remover configurações de benefício disponíveis para a integração. Para montar os itens do benefício, liste produtos e use o campo id retornado como product_id. O benefit_id retornado por essas rotas é o identificador que deve ser usado ao criar ou atualizar colaboradores e ao confirmar lotes.

Base path:

/api/v1/valepix/benefits

Modelo de benefício

Um benefício retornado pela API pode conter:

Campo	Tipo	Descrição
id	string	Identificador do benefício. Use este valor como benefit_id nas rotas de colaboradores
name	string	Nome do benefício
description	string	Descrição do benefício
coparticipation_percentage	number	Percentual de coparticipação configurado
items	array	Produtos e valores mensais que compõem o benefício

Objeto de items:

Campo	Tipo	Descrição
product_id	string	Identificador do produto vinculado ao item
product_slug	string	Slug do produto retornado pela API
product_name	string	Nome do produto retornado pela API
monthly_amount	number	Valor mensal do item em centavos

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}

Todas as rotas exigem um API token ativo.

Uso com colaboradores

Ao criar, atualizar ou confirmar colaboradores em lote:

1. Liste produtos em GET /api/v1/valepix/products.
2. Use o id do produto como product_id em POST /api/v1/valepix/benefits ou PUT /api/v1/valepix/benefits/{benefit_id}.
3. Guarde o id retornado na listagem de benefícios ou o benefit_id retornado na criação.
4. Envie esse valor no campo benefit_id das rotas de colaboradores.

Não use um benefit_id manual ou desconhecido; use apenas IDs retornados pela API.

Envelope de resposta

Em caso de sucesso, as respostas seguem o padrão:

{
  "success": "success",
  "data": {}
}

Em erros de validação, autenticação ou autorização, consulte Erros.