Pular para o conteúdo principal

Quickstart

Este guia valida o fluxo básico da API ValePix usando o token entregue pela ValePix.

Use o API token autorizado para acessar as rotas públicas.

Para uma sequência mais detalhada, com cadastro individual e cadastro em lote, siga Cadastrar colaboradores.

1. Configure variáveis​

export VALEPIX_BASE_URL="https://routes.valepix.com.br/api/v1"
export VALEPIX_API_TOKEN="<api_token>"

2. Liste produtos​

Use o campo id retornado como product_id ao criar ou atualizar benefícios.

curl --request GET \
  --url "$VALEPIX_BASE_URL/valepix/products?page=1&limit=10" \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Accept: application/json"

Guarde o identificador do produto desejado:

export PRODUCT_ID="<id_retornado_em_products>"

3. Crie um benefício​

O benefit_id retornado será usado no cadastro individual ou no commit de lote.

curl --request POST \
  --url "$VALEPIX_BASE_URL/valepix/benefits" \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --data "{
    \"name\": \"Benefício Flexível\",
    \"description\": \"Configuração padrão para colaboradores elegíveis\",
    \"coparticipation_percentage\": 0,
    \"items\": [
      {
        \"product_id\": \"$PRODUCT_ID\",
        \"monthly_amount\": 50000
      }
    ]
  }"

Guarde o identificador retornado:

export BENEFIT_ID="<benefit_id_retornado>"

4. Obtenha uma situação válida​

Use o campo value retornado pela rota de situações no payload de colaboradores.

curl --request GET \
  --url "$VALEPIX_BASE_URL/valepix/employees/situations" \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Accept: application/json"

Guarde o valor desejado:

export EMPLOYEE_SITUATION="active"

5. Liste colaboradores​

O token precisa estar ativo e autorizado.

curl --request GET \
  --url "$VALEPIX_BASE_URL/valepix/employees?page=1&limit=10" \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Accept: application/json"

6. Crie um colaborador​

Use birth_date e admission_date no formato YYYY-MM-DD.

curl --request POST \
  --url "$VALEPIX_BASE_URL/valepix/employees" \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --data "{
    \"benefit_id\": \"$BENEFIT_ID\",
    \"name\": \"Maria Exemplo Santos\",
    \"document\": \"<cpf_valido>\",
    \"email\": \"maria.exemplo@empresa.test\",
    \"phone\": \"<telefone_valido>\",
    \"birth_date\": \"1990-05-20\",
    \"cbo\": \"4110-05\",
    \"situation\": \"$EMPLOYEE_SITUATION\",
    \"admission_date\": \"2024-02-01\"
  }"

Resposta esperada:

{
  "success": "success",
  "data": {
    "employee_id": "00000000-0000-4000-8000-000000000001"
  }
}

Guarde o employee_id retornado:

export EMPLOYEE_ID="<employee_id_retornado>"

7. Busque o colaborador​

curl --request GET \
  --url "$VALEPIX_BASE_URL/valepix/employees/$EMPLOYEE_ID" \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Accept: application/json"

8. Atualize o colaborador​

curl --request PUT \
  --url "$VALEPIX_BASE_URL/valepix/employees/$EMPLOYEE_ID" \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --data "{
    \"benefit_id\": \"$BENEFIT_ID\",
    \"name\": \"Maria Exemplo Santos\",
    \"email\": \"maria.exemplo.novo@empresa.test\",
    \"phone\": \"<telefone_valido>\",
    \"cbo\": \"4110-05\",
    \"situation\": \"$EMPLOYEE_SITUATION\",
    \"admission_date\": \"2024-02-01\",
    \"birth_date\": \"1990-05-20\"
  }"

9. Remova ou desative o colaborador​

curl --request DELETE \
  --url "$VALEPIX_BASE_URL/valepix/employees/$EMPLOYEE_ID" \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Accept: application/json"

Resposta esperada:

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

Próxima validação​

Depois do fluxo individual, valide o envio em lote em Enviar lote de colaboradores e confirme o lote com o mesmo benefit_id.