Claus API
Una clau API permet que un altre sistema de la teva empresa —un ERP, un quadre de comandament, un script— llegeixi o escrigui a goPrevina a través de l'API REST, sense fer servir el compte de cap persona. Totes les crides van a la ruta base /api/v1.
1. Què hi ha a la pantalla
A dalt, el bloc «Crear una clau» amb el camp «Nom», els «Àmbits» («Lectura», «Escriptura», «Analítiques (webhook FHIR)» i «Proveïdor de salut laboral (només enviament)»), el selector «Abast» i el botó «Crear una clau». A sota, el desplegable «Permisos per recurs (API pública)» la llista de claus de l'empresa (si no n'hi ha cap, diu “Encara no hi ha claus API.”) i, al final, «Enviaments de proveïdors».
Quan hi ha almenys una clau, sobre la llista apareixen quatre targetes d'estat amb el seu recompte: “Caducades”, “Caduquen en 30 dies”, “Revocades” i “Actives”. Prem-ne una per veure només aquestes claus; torna-la a prémer per veure-les totes.
2. Crear una clau
1. Escriu un «Nom» que digui qui la fa servir (per exemple, “ERP de nòmines” o “quadre de comandament de direcció”).
2. Marca els «Àmbits»: «Lectura» si el sistema només consulta dades; afegeix «Escriptura» només si ha de crear o modificar registres. «Analítiques (webhook FHIR)» només es marca per a un laboratori que envia resultats per FHIR. «Proveïdor de salut laboral (només enviament)» és per a la clau d'un proveïdor de salut laboral o de cribratge d'Irlanda o del Regne Unit: substitueix els altres àmbits i l'abast queda a «Aquesta empresa». Amb ella el proveïdor envia cites, resultats d'aptitud, certificats i resultats de cribratge (JSON, FHIR R4 o CSV d'audiòmetre i espiròmetre) a la teva empresa i llegeix només els recomptes dels seus propis enviaments, res més.
3. A «Abast» tria «Aquesta empresa», «Totes les empreses del grup» (només un propietari o administrador del compte) o «Tots els clients de l'SPA» (només un administrador de l'SPA).
4. Si la clau només ha de tocar algunes dades, obre «Permisos per recurs (API pública)» i marca lectura o escriptura per recurs. «Lectura» i «Escriptura» no cobreixen l'aptitud mèdica ni el registre d'auditoria: cadascun necessita el seu permís.
5. Prem «Crear una clau». Apareix “Copia aquesta clau ara — no es tornarà a mostrar:”. Copia-la, guarda-la al sistema que la farà servir i prem “Fet”.
3. Rotar, revocar i vigilar l'ús
Cada clau de la llista mostra el seu nom, els seus àmbits, el seu abast si no és l'empresa i el seu “últim ús”. “Rotar” genera un valor nou per a la mateixa clau (l'anterior deixa de valer) i el mostra una sola vegada. “Revocar” obre la confirmació “Revocar clau API”: en acceptar, la clau deixa de funcionar de seguida i no es pot desfer. Fes-ho servir quan un sistema ja no la necessita o si sospites que s'ha filtrat.
Una clau revocada o caducada surt marcada com a “revocada” o “caducada” i ja no té botons. El consum de l'API respecte a la quota del teu pla es veu a “Monitoratge d'integracions”.
«Enviaments de proveïdors» llista el que ha enviat cada clau de proveïdor: el proveïdor (el nom de la clau), el tipus (cites, resultats d'aptitud, certificats, resultats de cribratge, FHIR, CSV d'audiòmetre o d'espiròmetre), els enviaments “Acceptats”, “Repetits” i “Rebutjats” i la data de recepció. Només mostra recomptes, mai dades clíniques.
4. Una clau per sistema
Crea una clau diferent per a cada sistema que es connecti: així, si un es retira o es compromet, revoques només la seva i els altres segueixen funcionant, i a “últim ús” veus quina està activa. La targeta “Caduquen en 30 dies” avisa de les que cal renovar amb temps.
La clau dona accés a les dades de l'empresa amb els àmbits que li has donat: guarda-la al gestor de secrets del sistema que la fa servir, mai en un correu ni en un full de càlcul.