API

La API permite que un sistema externo lea los datos de una cuenta de Safety Panel sin que una persona inicie sesión. La usan, por ejemplo, plataformas que necesitan el directorio de sitios de la cuenta para operar sobre él.

La API consulta datos y no crea ni modifica nada en Safety Panel, con una excepción: cada sistema puede guardar en un registro su propio identificador y sus propios datos, para reconocerlo después. Ver Asociar los registros con los de tu sistema.

Qué expone

Recurso	Qué contiene
account	La cuenta a la que pertenece la key. Sirve para comprobar que la credencial funciona.
sites	Los sitios de la cuenta, con su dirección, sus razones sociales responsables y su CUIT, su grupo y los profesionales asignados.
site_groups	Los grupos de sitios y los sitios que reúnen.
professionals	Los profesionales de la cuenta, con sus datos de contacto y si acceden a todos los sitios.
employees	Los empleados de la cuenta, con su número de legajo, su empleador y los sitios y puestos en los que trabajan.

Nada más: una key no lee capacitaciones, entregas de EPP ni ningún otro registro.

Los nombres de la API están en inglés

Los recursos y los campos se llaman en inglés, como es habitual en una API. Un site es un sitio, un site_group es un grupo de sitios, un professional es un profesional y un employee es un empleado, los mismos conceptos que se ven en el panel (ver el glosario).

Keys

Cada sistema externo se identifica con una key: un texto que empieza con spk_ y viaja en cada llamada. La key pertenece a la cuenta, no a una persona, y solo accede a los recursos que se le dieron al emitirla: cada uno en lectura o en lectura y escritura (ver Permisos).

Conviene emitir una key por sistema. Así, cuando uno cambia o deja de usarse, se revoca solo la suya y los demás siguen funcionando.

Safety Panel no guarda la key, solo una huella que permite reconocerla. Por eso se muestra una sola vez, al emitirla.

Una cuenta por dirección

La API responde en el subdominio de la cuenta. Una key de otra cuenta no abre esta, y un registro de otra cuenta responde igual que uno que no existe.

Sincronización incremental

Cada recurso informa cuándo cambió por última vez, y se puede pedir solo lo que cambió desde una fecha. Así otro sistema se mantiene al día sin volver a leer todo. Ver Sincronizar con otro sistema.

Guías

• Emitir una key
• Revocar una key
• Sincronizar con otro sistema
• Asociar los registros con los de tu sistema

Referencia

• Habilitación — Cómo se activa en la cuenta y quién gestiona las keys.
• Convenciones — Dirección, autenticación, errores, paginación, filtros y límites de uso.
• Recursos — Cada recurso con sus campos.