Fluxos de integração

Os cenários suportados pela API de integração, com endpoints e exemplos de payload. Schemas completos e teste interativo na Referência da API.

Funcionários e usuários

Sincronize o quadro de colaboradores a partir do seu RH/ERP.

AçãoEndpoint
Listar / detalhar funcionáriosGET /employees/ · GET /employees/{employee_id}/
Criar usuário de acessoPOST /accounts/create/ · POST /v2/users/mobile/create/ · POST /v2/users/manager/create/
Atualizar usuárioPUT /accounts/USER_ID/update/
Criar funcionárioPOST /employees/create/
Atualizar funcionárioPUT /employees/{id}/update/
Readmitir funcionárioPUT /employees/readmission/{id}/

Ordem recomendada: cadastros base → funcionário → usuário de acesso. Exemplos de payload no guia Primeiros passos.

Movimentações e abonos

Registre afastamentos, férias, abonos e justificativas vindos do RH.

Criar movimentação — POST /movimentation/

{
  "kind": 3,
  "employee": 315,
  "period": 87,
  "justification": 4,
  "begin_date": "2026-09-10",
  "end_date": "2026-09-12",
  "observation": "Atestado médico de 3 dias"
}

Obrigatórios: kind, employee, period e begin_date. kind aceita 0 (demissão), 2 (férias) ou 3 (afastamento) — não há valor padrão. end_date é obrigatório, exceto para demissão. justification é obrigatória em afastamento e férias quando existem justificativas cadastradas do tipo correspondente (6 para afastamento, 7 para férias).

Criar justificativa (tipo de movimentação) — POST /justifications/

{
  "name": "Atestado médico",
  "kind": 6,
  "amount": 1,
  "periodicity": 1,
  "blocked": false,
  "require_in_app": true,
  "require_in_web": true,
  "when_to_use": "Afastamentos por recomendação médica"
}

Obrigatórios: name, kind e amount (no PUT, também periodicity). kind: 0 inclusão de marcação, 1 exclusão de marcação, 2 abonos, 3 entrada manual, 4 mobile, 5 falta, 6 afastamento, 7 férias. periodicity: 0 semanal, 1 mensal, 2 trimestral, 3 semestral, 4 anual.

AçãoEndpoint
Listar / detalhar movimentaçõesGET /v2/movimentations/ · GET /v2/movimentations/{movimentation_id}
Criar / atualizar / remover movimentaçãoPOST /movimentation/ · PUT /movimentation/{id}/ · DELETE /movimentation/{id}/
Listar / detalhar justificativasGET /justifications/ · GET /justifications/{id}/
Criar / atualizar / remover justificativaPOST /justifications/ · PUT /justifications/{id}/ · DELETE /justifications/{id}/

Lançamentos manuais

Insira marcações que não passaram pelo registro eletrônico (decisão administrativa, ordem judicial etc.).

Lançar marcações — POST /v2/timeRecords/manual/ (V2, preferencial; V1: POST /manualEntry/)

{
  "employee_id": 315,
  "period_id": 87,
  "respect_limit": true,
  "records": [
    { "day": "2026-09-08", "hour": "08:00", "justification_id": 4 },
    { "day": "2026-09-08", "hour": "12:00", "justification_id": 4 },
    { "day": "2026-09-08", "hour": "13:00", "justification_id": 4 },
    { "day": "2026-09-08", "hour": "18:00", "justification_id": 4 }
  ]
}

Cadastros base

Mantenha a estrutura organizacional sincronizada. Disponíveis em V1 e V2 — prefira a V2.

RecursoConsultarCriarAtualizar
DepartamentoGET /v2/departaments/ · GET .../{departament_id}/POST /v2/departaments/PUT /v2/departaments/{departament_id}/
CargoGET /v2/departaments/positions/ · GET .../{position_id}/POST /v2/departaments/positions/PUT /v2/departaments/positions/{position_id}/
Horário/escalaGET /v2/schedules/ · GET .../{schedule_id}/POST /v2/schedules/PUT /v2/schedules/{schedule_id}/
CalendárioGET /v2/calendars/ · GET .../{calendar_date_id}/POST /v2/calendars/PUT /v2/calendars/{calendar_date_id}/
FeriadoGET /v2/calendars/holidays/ · GET .../{holiday_id}/POST /v2/calendars/holidays/PUT /v2/calendars/holidays/{holiday_id}/
EmpresaGET /enterprises/all/active/ · GET /enterprises/——
Convenção coletivaGET /collectiveAgreements/all/active/ · GET /collectiveAgreements/——
Vínculo empregatícioGET /employees/employment-relationship/——
Local de trabalhoGET /locals/all/ · GET /locals/——

Empresas, convenções coletivas, vínculos empregatícios e locais são cadastrados no sistema web do tenant — pela API de integração eles são somente consulta, usados para obter os ids exigidos na criação de funcionários.

Convenções coletivas ativas — GET /collectiveAgreements/all/active/ (sem paginação). O value é o id enviado em collective_agreement:

[
  { "value": 2, "name": "Convenção Comércio SP 2026", "active": true, "bank_of_hours": true }
]

Empresas ativas — GET /enterprises/all/active/ (sem paginação). O value é o id enviado em enterprise:

[
  { "value": 1, "name": "Empresa Exemplo LTDA", "status": "ATIVO", "document_number": "12345678000190", "can_active": false, "can_inactive": true }
]

Vínculos empregatícios — GET /employees/employment-relationship/ (paginação limit/offset). Opcional na criação de funcionários — sem o campo employment_relationship, o vínculo padrão é aplicado:

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    { "id": 1, "name": "CLT" },
    { "id": 2, "name": "Estagiário" }
  ]
}

Locais de trabalho — GET /locals/all/ (sem paginação). Campo local é opcional:

[
  { "id": 3, "name": "Matriz — São Paulo", "enterprise": 1 }
]

Exemplos de payload no guia Primeiros passos.

Acompanhamento em tempo real

O status de ponto da equipe, na mesma fonte usada pelo aplicativo do gestor.

Status da equipe — GET /v2/dashboard/team-status/

Filtros por query string: departament_id, status, search, limit, offset, pagination.

curl -L "https://<tenant>.api.blueponto.com.br/v2/dashboard/team-status/?departament_id=7&status=working" \
  --header "Authorization: JWT <token>"

Resposta (item):

{
  "employee_id": 315,
  "name": "Maria da Silva",
  "departament": "Operações",
  "position": "Analista de Operações",
  "status": "working",
  "tipo": "CLT",
  "last_entry": "2026-09-08T08:02:00",
  "late_minutes": 2,
  "image": "https://..."
}

Resumo agregado — GET /v2/dashboard/team-status/summary/

{
  "total": 128,
  "working": 97,
  "on_break": 12,
  "late": 5,
  "absent": 8,
  "day_off": 4,
  "out_of_shift": 2,
  "generated_at": "2026-09-08T10:15:00"
}

Did this page help you?