Las claves API son una simple cadena encriptada que puede utilizarse para generar un token de portador, que a su vez se utilizará para llamar a las API de GW Apps relacionadas con su dominio. Asegúrese de mantener todas sus claves seguras. Exponer públicamente sus credenciales puede poner en peligro sus datos.
| Claves de la API de la plataforma |
 |
| Artículo | Descripción |
| + Crear clave API | Haga clic en para crear una clave de API y seleccione los ámbitos de los usuarios y los roles compartidos. |
| Activado | Permite habilitar o deshabilitar la clave API específica. Cuando se desactiva, las solicitudes que utilizan esa clave serán ignoradas por GW Apps. |
 | Seleccione los tres puntos para ver las opciones de la tecla seleccionada. |
 | - – Generar nueva clave generará una nueva clave de API. Esto invalidará la clave anterior, por lo que tendrá que compartir la nueva clave con los desarrolladores de servicios que acceden a esta API. - – Referencia de la APIabrirá la documentación de la API sobre cómo llamar a los puntos finales de la API RESTful para las acciones de Usuario y Rol Compartido. - – Editar abre la configuración de la clave de la API seleccionada para editarla. - – Eliminar Elimina la configuración de la clave de la API seleccionada. |
Configuración de la clave API
| Artículo | Descripción |
| Nombre | Nombre de la clave API. |
| Descripción | [Opcional] Descripción de la clave de la API. |
| Detalles de seguridad | |
| Tipo | Seleccione "Todos los usuarios del dominio" para permitir que cualquiera ejecute una llamada a la API, o "Usuarios específicos" para permitir que sólo determinadas personas tengan acceso a la clave de la API. |
| Correo electrónico del usuario | Busque la dirección de correo electrónico de los usuarios dentro del dominio para concederles acceso para utilizar esta clave de API. (Se oculta si se selecciona "Todos los usuarios del dominio" para el Tipo). |
| Detalles de acceso | |
| Entidades | Seleccione "Usuarios" o "Roles compartidos". (Cuando se crea una nueva clave de API, ambas entidades ya aparecen en Detalles de acceso). |
| Ámbitos de selección | Establece el alcance o los permisos permitidos para los registros del formulario seleccionado. Las opciones para 'Usuarios' son: - Crear Usuario - Suspender Usuario - Activar Usuario - Ver y Buscar Usuarios - Exportar Registros a PDF - Ver Formulario Las opciones para 'Roles Compartidos' son: - Crear Rol Compartido - Actualizar Rol Compartido - Eliminar Rol Compartido - Ver y Buscar Roles Compartidos - Agregar Usuario a Rol Compartido - Eliminar Usuario de Rol Compartido (Cuando se crea una nueva Clave API, cada entidad tendrá todos los Ámbitos habilitados. Puede deseleccionar los ámbitos para deshabilitar el permiso,) |
Mejores prácticas de configuración de la clave de la API
Las claves API son una simple cadena encriptada que puede utilizarse para generar un token de portador, que a su vez se utilizará para llamar a sus API de GW Apps. Asegúrese de mantener todas sus claves API seguras. Exponer públicamente sus credenciales puede hacer que sus datos se vean comprometidos.
Al generar sus claves API, tenga en cuenta las siguientes sugerencias:
- Restrinja sus claves de API para permitir sólo direcciones de correo electrónico específicas: Recomendamos crear claves de API utilizando el tipo "Seleccionar usuarios" y, a continuación, seleccionar únicamente las direcciones de correo electrónico de los usuarios a los que desea acceder a los registros a través de la API. La API recuperará los datos basándose en los usuarios seleccionados con los que se generó el token, por lo que la API sólo tendrá acceso a los mismos datos de esta aplicación a los que tienen acceso los usuarios seleccionados. También puede seleccionar "Todos los usuarios del dominio", lo que le permitirá actuar como cualquier usuario en GW Apps y, por lo tanto, tener acceso completo a todos los datos de los formularios enumerados.
- Restrinja sus claves de API para que sólo se puedan utilizar en determinados formularios y ámbitos: Seleccione a qué formularios y a qué ámbitos tiene acceso su Clave de API. Esto limitará el nivel de acceso que tiene esta clave de API. Nota: Un ámbito sólo define qué acciones puede realizar una llamada a la API, no concede acceso a ningún dato a los usuarios seleccionados, o a todos los usuarios si se selecciona "Todos los usuarios del dominio" para el Tipo. La seguridad normal de acceso de los usuarios se aplica a todas las llamadas de la API. Esto significa que si el ámbito "Crear registro" está activado, si el usuario que llama a la API no tiene derechos para crear registros ("Quién puede crear nuevos registros" en la pestaña Configuración del formulario), la API devolverá un error 401 no autorizado.
- Regenere sus claves de API periódicamente: Puede regenerar las claves de la API desde la página de la lista de claves de la API haciendo clic en `Generar nueva clave` para cada clave. A continuación, actualice sus aplicaciones para utilizar las claves recién generadas. De este modo, aunque una clave de API sea encontrada por usuarios no deseados, dejará de ser válida después de un periodo porque se ha generado una nueva clave.
- Habilitar / Deshabilitar Claves API: Puedes desactivar tu clave de API en cualquier momento, eso desactivará cualquier llamada que intente utilizar esa clave de API.
- Elimine las claves API innecesarias: Para minimizar su exposición a los ataques, elimine las claves de API que ya no necesite.
Ajustes adicionales de la API
Este artículo cubre las opciones de la API a nivel de plataforma. Se pueden encontrar opciones adicionales para las claves de la API en la documentación de las opciones de la API dentro de la aplicación. Obtenga más información sobre cómo añadir claves a sus aplicaciones aquí.