Claves API

Unha clave API permite que outro sistema da túa empresa —un ERP, un cadro de mando, un script— lea ou escriba en goPrevina a través da API REST, sen usar a conta de ningunha persoa. Todas as chamadas van á ruta base /api/v1.

1. Que hai na pantalla

Arriba, o bloque «Crear unha clave» co campo «Nome», os «Ámbitos» («Lectura», «Escritura», «Analíticas (webhook FHIR)» e «Provedor de saúde laboral (só envío)»), o selector «Alcance» e o botón «Crear unha clave». Debaixo, o despregable «Permisos por recurso (API pública)» a lista de claves da empresa (se non hai ningunha, di “Aínda non hai claves API.”) e, ao final, «Envíos de provedores».

Cando hai polo menos unha clave, sobre a lista aparecen catro tarxetas de estado co seu reconto: “Caducadas”, “Caducan en 30 días”, “Revogadas” e “Activas”. Preme unha para ver só esas claves; prémea outra vez para velas todas.

2. Crear unha clave

1. Escribe un «Nome» que diga quen a usa (por exemplo, “ERP de nóminas” ou “cadro de mando de dirección”).

2. Marca os «Ámbitos»: «Lectura» se o sistema só consulta datos; engade «Escritura» só se ten que crear ou modificar rexistros. «Analíticas (webhook FHIR)» só se marca para un laboratorio que envía resultados por FHIR. «Provedor de saúde laboral (só envío)» é para a clave dun provedor de saúde laboral ou de cribado de Irlanda ou Reino Unido: substitúe os demais ámbitos e o alcance queda en «Esta empresa». Con ela o provedor envía citas, resultados de aptitude, certificados e resultados de cribado (JSON, FHIR R4 ou CSV de audiómetro e espirómetro) á túa empresa e le só os recontos dos seus propios envíos, nada máis.

3. En «Alcance» escolle «Esta empresa», «Todas as empresas do grupo» (só un propietario ou administrador da conta) ou «Todos os clientes do SPA» (só un administrador do SPA).

4. Se a clave só debe tocar algúns datos, abre «Permisos por recurso (API pública)» e marca lectura ou escritura por recurso. «Lectura» e «Escritura» non cubren a aptitude médica nin o rexistro de auditoría: cada un precisa o seu permiso.

5. Preme «Crear unha clave». Aparece “Copia esta clave agora — non se mostrará de novo:”. Cópiaa, gárdaa no sistema que a vai usar e preme “Feito”.

3. Rotar, revogar e vixiar o uso

Cada clave da lista amosa o seu nome, os seus ámbitos, o seu alcance se non é a empresa e o seu “último uso”. “Rotar” xera un valor novo para a mesma clave (o anterior deixa de valer) e móstrao unha soa vez. “Revogar” abre a confirmación “Revogar clave API”: ao aceptar, a clave deixa de funcionar de inmediato e non se pode desfacer. Úsao cando un sistema xa non a necesita ou se sospeitas que se filtrou.

Unha clave revogada ou caducada sae marcada como “revogada” ou “caducada” e xa non ten botóns. O consumo da API fronte á cota do teu plan vese en “Monitorización de integracións”.

«Envíos de provedores» lista o que enviou cada clave de provedor: o provedor (o nome da clave), o tipo (citas, resultados de aptitude, certificados, resultados de cribado, FHIR, CSV de audiómetro ou de espirómetro), os envíos “Aceptados”, “Repetidos” e “Rexeitados” e a data de recepción. Só amosa recontos, nunca datos clínicos.

4. Unha clave por sistema

Crea unha clave distinta para cada sistema que se conecte: así, se un se retira ou se compromete, revogas só a súa e os demais seguen funcionando, e en “último uso” ves cal está activo. A tarxeta “Caducan en 30 días” avisa das que hai que renovar con tempo.

A clave dá acceso aos datos da empresa cos ámbitos que lle deches: gárdaa no xestor de segredos do sistema que a usa, nunca nun correo nin nunha folla de cálculo.