Configuración del registro de la app

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X. info

Los desarrolladores usan la página Mis apps del portal de servicios para desarrolladores para registrar apps. Los desarrolladores acceden a la página Mis apps desde el menú principal del portal:

Para registrar una app nueva, el desarrollador selecciona el botón Agregar una app nueva en la página Mis apps.

Luego, el portal muestra el formulario de registro de apps predeterminado:

De forma predeterminada, el desarrollador solo tiene que especificar el nombre de la app, la URL de devolución de llamada y la lista de productos de API que se agregarán a la app.

Como proveedor de API, tienes un control total sobre el proceso de registro de apps. Por ejemplo, puedes configurar lo siguiente:

  • La lista de productos de API disponibles en el portal
  • Si hay un producto de API predeterminado
  • Indica si la URL de devolución de llamada es obligatoria.
  • Si la clave de API se aprueba de forma manual o automática para un producto de API
  • Si se requiere alguna otra información en la página Agregar aplicación para registrarla

En este tema, se describe cómo configurar el proceso de registro de apps para tu portal. Sin embargo, en este tema no se describe cómo crear productos de API. Para obtener más información, consulta los siguientes recursos:

Puedes configurar el portal para prohibir que los desarrolladores puedan crear, borrar o editar apps según el rol asignado al desarrollador. Por ejemplo, puedes configurar el portal para que cree una sola app predeterminada para todos los desarrolladores cuando se registren. Luego, solo permites que algunos desarrolladores agreguen apps nuevas, posiblemente según una estructura de tarifas o alguna otra característica del desarrollador. Usa roles y permisos para controlar qué desarrolladores pueden crear, borrar y editar apps. Consulta Cómo agregar y administrar cuentas de usuario para obtener más información.

Especifica los productos de API disponibles en el portal

Existen dos maneras en las que puedes especificar los productos de API que están disponibles cuando un desarrollador accede al portal:

Cómo especificar el nivel de acceso cuando creas un producto de API

Cuando creas un producto de API, especificas la opción de nivel de acceso del producto, como se muestra a continuación:

Para obtener más información sobre cómo el nivel de acceso afecta la disponibilidad del producto de la API en el portal para desarrolladores de Drupal 7, consulta Nivel de acceso.

Restringe el acceso a un producto de API según los roles

Si habilitas el módulo de acceso de roles de productos de API de Drupal, puedes especificar los roles que pueden acceder a cada producto de API.

Para restringir el acceso a un producto de API según los roles de desarrollador, sigue estos pasos:

  1. Accede a tu portal como un usuario con privilegios de administrador o creación de contenido.
  2. Revisa los roles del portal para desarrolladores y las asignaciones de usuarios:
    • Selecciona Personas > Permisos > Roles en el menú de administración de Drupal y agrega o edita los roles y permisos de desarrollador según sea necesario.
    • Selecciona Personas en el menú de administración de Drupal y edita las asignaciones de usuarios y roles según sea necesario.
  3. Selecciona Configuración > Portal para desarrolladores > Acceso a roles de productos de API en el menú de administración de Drupal.
  4. Selecciona los roles que deseas que puedan acceder a cada producto de la API.
  5. Haga clic en Guardar configuración.

Cómo configura un desarrollador la asociación de productos de API con una app

Para registrar una app nueva, un desarrollador selecciona el botón Agregar una app nueva en la página Mis apps para abrir el formulario Agregar app:

Según la configuración del portal, el desarrollador puede seleccionar uno o más productos de API para asociarlos con la app en el momento del registro. También puedes especificar un producto predeterminado que se asigne a todas las apps.

Las siguientes opciones de configuración están disponibles en el portal para controlar la selección de productos de API cuando se registra una app:

  • No asocies apps con ningún producto de API.
  • Asocia todas las apps con uno o más productos de API predeterminados (se configuran a continuación). Los desarrolladores no pueden agregar ningún otro producto de API a la app.
  • Permite la selección de un solo producto de API, pero no lo exijas.
  • Se requiere la selección de un solo producto de API.
  • Permite la selección de varios productos de API, pero no los exijas.
  • Permite la selección de varios productos de API y requiere al menos uno.

También puedes controlar el elemento HTML que aparece en el formulario que usa el desarrollador para seleccionar el producto de la API. Incluye las siguientes opciones:

  • Listas desplegables
  • Casillas de verificación o botones de selección Las casillas de verificación aparecen cuando el desarrollador puede seleccionar varios productos de API, y los botones de selección aparecen cuando el desarrollador puede seleccionar solo un producto de API.

Para configurar la opción de selección de productos de API, sigue estos pasos:

  1. Accede a tu portal como un usuario con privilegios de administrador o creación de contenido.
  2. Selecciona Configuración > Configuración del portal para desarrolladores > Configuración de la aplicación en el menú de administración de Drupal.
  3. En la página Configuración de la aplicación, expande el área Configuración del producto de API.
  4. En Manejo de productos de API, selecciona la opción que controla la selección de productos de API.
  5. Si especificas la opción "Asociar todas las apps con uno o más productos de API predeterminados (se configura a continuación)", establece un producto predeterminado en Producto de API predeterminado.
  6. En Widget de productos de API, selecciona el elemento HTML que usan los desarrolladores para seleccionar los productos de API.
  7. Guarde la configuración.

Cómo configurar el manejo de la URL de devolución de llamada

Si un proxy de API en tu producto de API usa "OAuth de tres segmentos" (tipo de otorgamiento de código de autorización), los desarrolladores deben especificar una URL de devolución de llamada cuando registren sus apps. La URL de devolución de llamada suele especificar la URL de una app designada para recibir un código de autorización en nombre de la app cliente. Además, esta cadena de URL se usa para la validación. El cliente debe enviar esta URL a Apigee Edge cuando solicite códigos de autorización y tokens de acceso, y el parámetro redirect_uri debe coincidir con el que está registrado. Para obtener más información, consulta Implementa el tipo de otorgamiento de código de autorización.

Para controlar la URL de devolución de llamada para la selección de productos de la API, sigue estos pasos:

  1. Accede a tu portal como un usuario con privilegios de administrador o creación de contenido.
  2. Selecciona Configuración > Configuración del portal para desarrolladores > Atributos de la aplicación en el menú de administración de Drupal.
  3. En la página Configuración de la aplicación, expande el área Configuración de la URL de devolución de llamada.
  4. En Manejo de la URL de devolución de llamada, selecciona una de las siguientes opciones.
    • La URL de devolución de llamada es obligatoria para todas las apps de desarrollador.
    • La URL de devolución de llamada es opcional para todas las apps de desarrolladores.
    • No se requiere ni se muestra la URL de devolución de llamada.
  5. Guarde la configuración.

Cómo mostrar estadísticas del uso de la app

El portal puede mostrar información analítica sobre el uso de la app. Si la visualización de estadísticas está habilitada, los desarrolladores de apps pueden ver las estadísticas en la página Mis apps de cada app. Por ejemplo, un desarrollador puede mostrar las siguientes estadísticas de una app:

  • Capacidad de procesamiento
  • Tiempo de respuesta máximo
  • Tiempo de respuesta mínimo
  • Recuento de mensajes
  • Cantidad de errores

Para habilitar las estadísticas en el portal, sigue estos pasos:

  1. Accede a tu portal como un usuario con privilegios de administrador o creación de contenido.
  2. Selecciona Configuración > Portal para desarrolladores > Configuración de la aplicación en el menú de administración de Drupal.
  3. En la página Configuración de la aplicación, expande el área Configuración de rendimiento de la app.
  4. Selecciona la casilla de verificación Mostrar la pestaña Estadísticas de la app para desarrolladores.
  5. Selecciona Prueba o Producción para Entorno para consultar datos de estadísticas. En el caso de un portal disponible para el público, por lo general, debes seleccionar Producción.
  6. Guarde la configuración.

Para mostrar estadísticas en el portal de una app, sigue estos pasos:

  1. Selecciona el nombre de la app en la página Mis apps.
  2. Selecciona el vínculo Analytics de la aplicación.
  3. Selecciona el tipo de estadísticas que deseas mostrar y el período:
  4. Aparecerá la información seleccionada:

Aprueba o revoca de forma manual una clave de API para un producto de API

Cuando un desarrollador agrega un producto de API a una app y, luego, la registra, el portal le muestra al desarrollador la clave de API de esa app. Luego, el desarrollador usa esa clave de API para acceder a los proxies de API que incluye el producto de API asociado con la app.

Controlas el proceso de aprobación de claves de cada producto de API cuando lo creas:

El proceso de aprobación puede ser uno de los siguientes:

  • Automática: El portal muestra una clave de API aprobada para el producto de API cuando el desarrollador registra la app. Más adelante, puedes revocar una clave aprobada automáticamente.
  • Manual: El portal muestra una clave de API cuando el desarrollador registra la app, pero la clave no se activa para ningún producto de API que use la aprobación manual de claves. Un administrador debe aprobar manualmente la clave de API, ya sea en la IU o la API de administración de Edge, antes de que el desarrollador pueda usarla para acceder al producto de la API. Más adelante, puedes revocar una clave aprobada de forma manual.

Consulta Crea productos de API para obtener más información.

Si tu portal permite que un desarrollador agregue varios productos de API a una app, es posible que agregue algunos productos con aprobación automática de claves y otros con aprobación manual. El desarrollador puede usar la clave de API que se muestra para todos los productos de API aprobados automáticamente de inmediato mientras espera la aprobación final de los productos que requieren aprobación manual.

Para ver la lista de productos de API de una app y el estado de la aprobación de la clave del producto de API, un desarrollador selecciona el nombre de la app en la página Mis apps y, luego, el vínculo Productos:

En este ejemplo, el producto de la API de Premium Weather usa la aprobación manual y está esperando que un administrador apruebe la clave. El producto de API gratuito usa la aprobación automática, y se aprobó el uso de la clave para acceder a él.

Para aprobar o revocar una clave de forma manual, haz lo siguiente:

  1. Accede a la IU de administración de Edge como un usuario con privilegios de administración de tu organización.
  2. Selecciona API Platform en el cuadro desplegable de la esquina superior derecha.
  3. Selecciona Publicar > Apps para desarrolladores para abrir la lista de apps para desarrolladores.
  4. Selecciona el botón Pendiente para ver la lista de apps con solicitudes de claves pendientes:

  5. Selecciona el nombre de la app que quieres aprobar.
  6. En la página de detalles de la app, selecciona el botón Editar en la esquina superior derecha.
  7. En la lista de productos de API de la app, en Acciones, haz lo siguiente:
    • Para aprobar la clave, selecciona el botón Aprobar para cada producto de API que requiera aprobación manual.

    • Para revocar una clave aprobada, selecciona el botón Revoca en Acciones para que un producto de API revoque el acceso.

  8. Guarda la app. La clave de API ya está aprobada.

Controla el almacenamiento en caché de productos de API y apps

La información sobre los productos de API y las apps para desarrolladores se almacena de forma remota desde el portal en Apigee Edge. Esto significa que los cambios en los productos y las apps de la API se pueden realizar desde la IU o la API de Edge, sin pasar por el portal. Por ejemplo, cuando un administrador de backend agrega un producto de API nuevo, el portal no se actualiza de inmediato con esa información.

Para asegurarte de que el portal permanezca sincronizado con el backend de Edge, puedes activar manualmente una actualización de la caché del portal, actualizar las cachés automáticamente cuando se ejecuta el trabajo cron del portal o ambas. Por ejemplo, si configuras el trabajo cron para que se ejecute con frecuencia, por ejemplo, cada 5 o 10 minutos, es posible que no quieras la sobrecarga de actualizar los productos de la API y las cachés de apps para desarrolladores con tanta frecuencia. En esta situación, puedes activar la actualización de la caché de forma manual. Sin embargo, si la tarea de cron se ejecuta cada hora o cada dos horas, el tiempo necesario para actualizar las cachés podría no tener mucho impacto.

De forma predeterminada, el portal está configurado para volver a compilar el producto de API y las cachés de la app para desarrolladores cada vez que se ejecuta cron.

Para especificar si se deben volver a compilar las cachés del producto de API y de la app para desarrolladores cada vez que se ejecuta cron, haz lo siguiente:

  1. Accede a tu portal como un usuario con privilegios de administrador o creación de contenido.
  2. En el menú de Drupal, selecciona Configuración > Configuración del portal para desarrolladores > Configuración de la aplicación.
  3. Marca o desmarca la opción Volver a compilar las cachés del producto de API y de la app para desarrolladores cada vez que se ejecuta cron.
  4. Guarde la configuración.

Para actualizar las cachés de forma manual, sigue estos pasos:

  1. Accede a tu portal como un usuario con privilegios de administrador o creación de contenido.
  2. En el menú de Drupal, selecciona el ícono de Página principal > Borrar todas las cachés.

Personaliza los campos del formulario que se usan para registrar una app

Cuando el desarrollador registra una app, el portal muestra el formulario predeterminado:

Como proveedor de la API, te recomendamos que modifiques este formulario para solicitarle al desarrollador que proporcione información adicional, como un ID de cliente, la plataforma de destino de la app o cualquier otra información. El portal te permite agregar campos nuevos a este formulario. Estos campos pueden ser los siguientes:

  • Obligatorio u opcional
  • Se muestran a través de diferentes elementos HTML, como cuadros de texto, botones de selección, casillas de verificación y mucho más.
  • Se puede configurar para que aparezca en cualquier lugar del formulario entre el campo URL de devolución de llamada y el campo Producto

Para obtener información sobre cómo personalizar el formulario de registro de apps que está disponible en el portal para desarrolladores, mira este video.

Por ejemplo, en el siguiente formulario, se muestra un campo obligatorio para el ID de cliente y un campo opcional para la plataforma de destino:

Cuando agregas campos nuevos al formulario, los valores de los campos se suben automáticamente a Edge, junto con todos los demás campos, cuando el desarrollador envía el formulario. Eso significa que puedes ver o modificar esos campos en Edge, o usar la API de administración de Edge para acceder a esos campos desde una secuencia de comandos.

Por ejemplo, para ver los nuevos campos de formulario en la IU de administración de Edge, ve a Publish > Developer Apps y, luego, selecciona el nombre de la app. Los valores de campo nuevos aparecen en el área Custom Attributes de la página con un nombre que corresponde al nombre interno del campo:

Los valores de los campos también se muestran en el área Detalles de la app en la página Mis apps del desarrollador:

El desarrollador también puede editar los valores seleccionando el vínculo Editar de la app en la página Mis apps.

En los siguientes procedimientos, se describe cómo configurar los formularios de creación de apps con la interfaz de administrador. Un desarrollador de Drupal puede realizar personalizaciones adicionales, incluida la modificación de la página “Mis apps”, con hooks personalizados. Para obtener más información sobre cómo cambiar los comportamientos a través del código, consulta los ejemplos de la API de la app en el archivo /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php.

Para agregar un campo al formulario de registro de la app, sigue estos pasos:

  1. Accede a tu portal como un usuario con privilegios de administrador o creación de contenido.
  2. Asegúrate de que el módulo Administración de atributos de apps de DevConnect esté habilitado.
  3. Selecciona Configuración > Configuración del portal para desarrolladores > Atributos de la app del portal para desarrolladores en el menú de administración de Drupal.
  4. Selecciona el botón Add Dev Portal App Attribute en la parte superior de la página.
  5. Configura el campo. Por ejemplo, para el campo ID de cliente que se muestra arriba, usa la siguiente configuración:
    • Nombre interno = cust_id. Este es el nombre de la variable que se usa para almacenar el valor del campo.
    • Nombre público = ID de cliente
    • Descripción: Ingresa tu ID de cliente.
    • Selecciona la casilla de verificación para Solicitar este atributo.
    • Selecciona la casilla de verificación para mostrar este atributo.
    • Widget = Cuadro de texto
    • Selecciona Guardar para volver a la página Atributos de la app del portal para desarrolladores.
  6. Selecciona Guardar cambios.
  7. En el menú de Drupal, selecciona Ícono de inicio > Borrar todas las cachés.
    Es posible que debas borrar la caché del navegador para que aparezca el nuevo campo en el formulario.

Para agregar un campo opcional para que el desarrollador especifique la plataforma de la app, establece los atributos del campo de la siguiente manera:

  • Nombre interno = intended_platforms
  • Nombre público = Plataformas
  • Descripción: Especifica una o más plataformas para tu app.
  • Desmarca las casillas de verificación para Solicitar este atributo.
  • Selecciona la casilla de verificación para Mostrar este atributo.
  • Widget: Lista de casillas de verificación
  • Selecciona Guardar para volver a la página Atributos de la app del portal para desarrolladores.

Para reorganizar los atributos del formulario, sigue estos pasos:

  1. Accede a tu portal como un usuario con privilegios de administrador o creación de contenido.
  2. Selecciona Configuración > Configuración del portal para desarrolladores > Atributos de la app del portal para desarrolladores en el menú de administración de Drupal.
  3. Selecciona el símbolo de signo más, +, en la columna Nombre y arrastra la propiedad a la ubicación en la que deseas mostrarla en el formulario.
  4. Guarda los cambios.