GW Apps tiene una API que permite a los sistemas externos autorizados leer y modificar registros mediante un servicio web RESTful. La definición de una clave de API es la forma de hacer saber a GW Apps que formularios específicos dentro de la aplicación pueden permitir el acceso a la API, y qué operaciones puede realizar la API. En este artículo hablaremos de cómo puede crear y generar claves de API para sus aplicaciones. También hablaremos de las opciones de configuración de la clave de API.
Descripción de la clave API
Las claves API permiten la creación de puntos finales RESTful que harán que los registros de un determinado formulario sean accesibles y editables a través de un servicio web.
| Claves API |
 |
 |
| Artículo | Descripción |
| + Crear clave API | Cree una nueva clave API. |
| Nombre | Nombre de la clave API. |
| Descripción | Breve descripción de la clave API. |
| Creado en | Fecha de creación de la clave API. |
| Creado por | Usuario que creó la clave de la API. |
| Activado | Opción para activar/desactivar el acceso mediante esta clave de API. |
| Haga clic en una fila | Al hacer clic en una fila de la clave de la API en la lista, se expandirá un panel debajo de la fila con detalles resumidos sobre la configuración de la clave de la API. |
 | Haga clic en el menú de tres puntos para ver más opciones. |
| Generar nueva clave | Genera una nueva clave de seguridad para la configuración de la clave de la 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 API | Enlace a la documentación sobre cómo llamar a los puntos finales de la API RESTful para el formulario especificado |
| Editar | Editar la configuración de la Clave API seleccionada. |
| Eliminar | Elimina la configuración de la clave de la API seleccionada. |
Creación de una clave API
Cree una nueva clave API haciendo clic en el botón "+ Crear clave API" y completando el formulario de diálogo emergente que aparece:
| Creación de una clave API |
 |
Una vez que haya introducido el nombre de la nueva clave API, y opcionalmente haya añadido una descripción, y haya hecho clic en "Crear", verá el Editor de Claves API con su nueva clave cargada para que pueda completar su configuración:
| Crear claves de API |
 |
| Artículo | Descripción |
| Clave API generada | Cadena que representa la clave de la API generada, esto se mostrará sólo cuando la clave se crea por primera vez, por lo que se recomienda encarecidamente escribirla en un lugar seguro, ya que no será visible una vez que se guarde y se salga de la pantalla. |
| 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 | |
| Formulario | Seleccione un formulario de la aplicación actual que será accesible a través de esta clave API. (Cuando se crea una nueva clave de API, todos los formularios dentro de la aplicación se añadirán a la lista de formularios en Detalles de acceso). |
| Seleccionar ámbitos | Establece el alcance o los permisos permitidos para los registros del formulario seleccionado. Las opciones son: - Crear Registros - Actualizar Registros - Eliminar Registros - Ver y Buscar Registros - Exportar Registros a PDF - Ver Formulario (Cuando se crea una nueva Clave API, cada formulario tendrá todos los Ámbitos habilitados. Puede deseleccionar los ámbitos para desactivar el permiso). |
 | Añadir acceso para un formulario adicional desde esta aplicación. |
| Cancelar | Cancelar los cambios |
| Guardar | Guardar las claves de la API |
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 las API de GW Apps relacionadas con sus aplicaciones. Asegúrese de mantener todas sus claves seguras. Exponer públicamente tus credenciales puede hacer que tus datos se vean comprometidos.
Configuraciones de claves API
Al generar su clave API, puede configurar las siguientes opciones de seguridad:
- 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 refleja las opciones de la API dentro de la aplicación. Las opciones adicionales para las claves de la API se pueden encontrar en la sección de la API de la configuración de la plataforma.