Registrar una aplicación externa

Objetivo

Registrar un sistema externo (una integración, un servicio o un middleware) para que pueda llamar a las API de Parsware con sus propias credenciales.

Requisitos previos

• Ha iniciado sesión en el Centro de control de administración como administrador de la plataforma.
• Sabe qué ámbitos necesita el sistema externo (por ejemplo, acceso de lectura a los datos de las aplicaciones).

Pasos

1. Abra la página Registros de aplicaciones desde la navegación de la izquierda.
2. Escriba un nombre de aplicación que identifique el sistema externo.
3. Seleccione en la lista los ámbitos que necesita la aplicación. Cada ámbito concede un tipo de acceso concreto.
4. Elija los roles de seguridad que tendrá la aplicación, si los hay. Dejarlo vacío es el privilegio mínimo: la aplicación puede llamar a la plataforma pero no tocar ningún registro. Un script de API personalizada se ejecuta como la aplicación, con estos roles, así que una aplicación cuyos scripts leen o escriben registros necesita exactamente el rol que puede hacerlo, y ese rol solo debería tener permisos en los entornos a los que da servicio la aplicación.
5. Seleccione Registrar aplicación.
6. Un panel muestra el nuevo Id. de cliente y el Secreto de cliente. Copie el secreto de cliente ahora: solo se muestra una vez y no se puede recuperar después.

Qué ocurre entre bastidores

La aplicación externa pasa a ser un cliente de API registrado. Se autentica con su id. de cliente y su secreto para obtener un token de acceso de corta duración y, después, llama a las API de Parsware con ese token. El token se limita exactamente a los ámbitos que usted concedió, nombra a su inquilino y lleva los roles que eligió, que son los que deciden a qué registros puede llegar.

Solución de problemas

• «Scope … can only be granted by the platform operator.» — parsware.provision y parsware.portals.serve pertenecen a los servidores del operador de la plataforma (el sitio web, el host de portales) y no aparecen en su lista. Ninguna de sus aplicaciones los necesita.
• Una aplicación revocada siguió respondiendo un rato. Revocar le impide obtener tokens nuevos al instante, pero cada servicio comprueba por su cuenta el token que ya tiene, que sigue funcionando hasta caducar, en menos de una hora. Para cortarla al instante, quite también los permisos de su rol en ese entorno: se comprueban en cada llamada.
• «El ámbito … no es un ámbito conocido de la plataforma». — un ámbito solicitado no está en el catálogo. Seleccione ámbitos solo de la lista que se muestra.
• «El rol … no existe en este inquilino». — un rol elegido se eliminó antes de guardar el registro. Vuelva a abrir el panel y elija de nuevo.
• «Se debe conceder al menos un ámbito». — seleccione al menos un ámbito antes de registrar.
• Ha perdido el secreto de cliente — el secreto no se puede recuperar. Revoque el registro y vuelva a registrar la aplicación para obtener un secreto nuevo.

Escenarios relacionados

• Revocar una aplicación externa.