Documentación API

API Externa Avos

API RESTful para integrar tus sistemas con la nómina. Autenticación por API Key, documentación Swagger completa.

Inicio rápido

En el panel, ve a API Keys → Nueva clave. Define los alcances necesarios.

Envía el header Authorization: Bearer pk_live_... en todas las peticiones.

GET /api/external/v1/employees para listar empleados de la empresa.

Ejemplo de autenticación

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

Lee y gestiona datos de empleados vía API.

GETPOSTPATCHemployees:reademployees:write

Consulta y crea departamentos de la empresa.

GETPOSTdepartments:readdepartments:write

Accede a posiciones y estructura de cargos.

GETPOSTpositions:readpositions:write

Consulta, calcula y aprueba la nómina por la API.

GETPOSTpayroll:readpayroll:write

Consulta fichajes y registra entradas y salidas.

GETPOSTtimeclock:readtimeclock:write

Exporta informes de nómina y plantilla.

GETreports:read