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 es de solo lectura: consulta datos, pero no crea ni modifica nada en Safety Panel.

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, su CUIT, su grupo y los profesionales asignados.
site_groups	Los grupos de sitios, con su CUIT y los sitios que reúnen.
professionals	Los profesionales de la cuenta, con sus datos de contacto y si acceden a todos los sitios.

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 y un professional es un profesional, los mismos conceptos que se ven en el panel (ver el glosario).

Cómo está organizada esta guía

1. Habilitación y keys: cómo se activa la API en una cuenta y cómo se emite o se revoca una key.
2. Convenciones: la dirección, la autenticación, los errores, la paginación, los filtros y los límites de uso. Valen para todos los recursos.
3. Recursos: cada recurso con sus campos.

Principios

• Una key por sistema. Cada key pertenece a la cuenta, no a una persona, y lee todo lo que la cuenta tiene. Si un sistema deja de usarse, se revoca su key y los demás siguen funcionando.
• Una cuenta por dirección. La API responde en el subdominio de la cuenta. Una key de otra cuenta no abre esta.
• Sincronización incremental. Cada recurso informa cuándo cambió por última vez y se puede pedir solo lo que cambió desde una fecha (ver filtros).