Saltar al contingut principal

Autenticació i autorització

L'accés a l'API està protegit per garantir que només clients autenticats i autoritzats puguin interactuar amb els recursos disponibles.

En aquesta secció es descriu com autenticar-se mitjançant clau d’API i com s'apliquen els controls d'autorització.

Autenticació​

L'API utilitza un mecanisme d'autenticació basat en clau d’API.

Totes les sol·licituds han d'incloure la clau en la capçalera Authorization utilitzant l'esquema Bearer:

Autorització: Portador <api_key>

Tot i que s'utilitza l'esquema Bearer, el valor correspon directament a una clau d’API generada en Portal, i no a un token obtingut mitjançant un procés d'autenticació addicional.

Clau d’API​

  • És l'únic mecanisme d'autenticació disponible.
  • S'ha d'enviar en totes les sol·licituds.
  • Identifica l'usuari, el seu rol i l'organització a la que pertany.

Generar una clau d’API​

Per crear aquesta clau és necessari que l'usuari tingui rol de Administrador d'organització.

  1. Accedir a Portal.

    api-11

  2. Al menú lateral, fes clic a Configuració → Organització.

  3. Selecciona la pestanya Clauds d’API.

    api-2

  4. Fes clic a Crear clau d’API.

  5. Completa el formulari.

    api-3

  • Nom. Identificador de la clau API.
  • Rol. Rol assignat a l'usuari en Portal.
  • Durada. Temps de validesa de la clau.
  1. Confirma amb Guardar.

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 diferents nivells:

  1. Nivell d'endpoint: determina quins rols poden accedir a cada endpoint.
  2. Nivell d'acció: restringeix operacions específiques (per exemple, accions de modificació o eliminació) en funció dels permisos de l'usuari.
nota

L'accés als recursos depèn dels permisos de l'usuari definits en Portal. No tots els endpoints estan disponibles per a tots els rols.

Bones pràctiques​

  • Mantingues la clau d’API segura.
  • Genera noves claus periòdicament.
  • Revocar claus compromeses.