Documentação API

API Externa Avos

API RESTful para integrar seus sistemas com a folha de pagamento. Autenticação por API Key, documentação Swagger completa.

Início rápido

No painel, acesse API Keys → Nova chave. Defina os escopos necessários.

Envie o header Authorization: Bearer pk_live_... em todas as requisições.

GET /api/external/v1/employees para listar funcionários da empresa.

Exemplo de autenticação

curl https://api.useavos.app/api/external/v1/employees \
  -H "Authorization: Bearer pk_live_sua_chave_aqui" \
  -H "Content-Type: application/json"

Leia e gerencie dados de funcionários via API.

GETPOSTPATCHemployees:reademployees:write

Consulte e crie departamentos da empresa.

GETPOSTdepartments:readdepartments:write

Acesse posições e estrutura de cargos.

GETPOSTpositions:readpositions:write

Consulte, calcule e aprove a folha de pagamento pela API.

GETPOSTpayroll:readpayroll:write

Consulte marcações e registre batidas de ponto.

GETPOSTtimeclock:readtimeclock:write

Exporte relatórios de folha e headcount.

GETreports:read