Autenticació
L’API utilitza un mecanisme d’autenticació basat en claus d’API (API Keys). Cada clau d’API està associada a un usuari de Portal i representa la seva identitat durant les sol·licituds realitzades a l’API. No és necessari obtenir un token d’accés previ ni completar un procés d’autenticació addicional.Clau d’API
La clau d’API és l’únic mecanisme d’autenticació admès per la plataforma. Característiques:- S’ha d’incloure en totes les sol·licituds.
- Identifica l’usuari que fa la petició.
- Limita l’accés a l’organització a la qual pertany l’usuari.
Autorització
L’accés als recursos de l’API està controlat mitjançant un sistema d’autorització basat en rols. L’autorització s’aplica en dos nivells:- Nivell d’endpoint. Determina quins rols poden accedir a cada endpoint.
- Nivell d’acció. Restringeix operacions concretes, com ara crear, modificar o eliminar recursos, segons els permisos de l’usuari.
L’accés als recursos depèn dels permisos de l’usuari definits a Portal. No tots els endpoints estan disponibles per a tots els rols.
Bones pràctiques
Per protegir les integracions que utilitzen l’API, es recomana:- Mantenir les claus d’API en un lloc segur.
- No compartir-les ni incloure-les en codi font públic.
- Rotar les claus periòdicament.
- Revocar immediatament qualsevol clau que pugui haver-se vist compromesa.