Configuración del registro de la app

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Información

Los desarrolladores usan la página Mis apps del portal de servicios para desarrolladores a fin de registrar apps. Los desarrolladores pueden acceder a la página Mis aplicaciones 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, en el portal, se mostrará 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 para agregar a la app.

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

  • La lista de productos de API disponibles en el portal
  • Si hay un producto de API predeterminado
  • Si se requiere la URL de devolución de llamada
  • 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 app para registrar la app

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 lo siguiente:

Puedes configurar el portal para prohibir que los desarrolladores puedan crear, borrar o editar apps según la función asignada al desarrollador. Por ejemplo, puedes configurar el portal para crear una única app predeterminada para todos los desarrolladores cuando estos se registren. Luego, solo permites que algunos desarrolladores agreguen apps nuevas, posiblemente en función de una estructura de tarifas o de otras características del desarrollador. Usa roles y permisos para controlar qué desarrolladores pueden crear, borrar y editar apps. Para obtener más información, consulta Cómo agregar y administrar cuentas de usuario.

Especificar los productos de API disponibles en el portal

Existen dos maneras de 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 API en el portal para desarrolladores de Drupal 7, consulta Nivel de acceso.

Restringir el acceso a un producto de API según las funciones

Si habilitas el módulo de Drupal de acceso a funciones de productos de API, puedes especificar las funciones 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 de 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 permisos y las funciones de desarrollador, según sea necesario.
    • Selecciona Personas en el menú de administración de Drupal y edita las asignaciones de usuarios y funciones según sea necesario.
  3. Selecciona Configuración > Portal para desarrolladores > Acceso a roles del producto de API en el menú de administración de Drupal.
  4. Selecciona las funciones que deseas que tengan acceso a cada producto de API.
  5. Haga clic en Guardar configuración.

Configura la forma en que un desarrollador asocia productos de API con una app

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

Según cómo configures el portal, el desarrollador puede seleccionar uno o más productos de API para asociarlos con la app cuando se registre. 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 la 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 (configurados 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 es obligatorio.
  • Requerir la selección de un solo producto de API.
  • Permite la selección de varios productos de API, pero no se requiere ninguno.
  • 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 API. Estas son algunas 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 elegir solo un producto de API.

Si quieres 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 de creación de contenido.
  2. En el menú de administración de Drupal, selecciona Configuración > Configuración del portal para desarrolladores > Configuración de la aplicación.
  3. En la página Configuración de la aplicación, expande el área Configuración del producto de API.
  4. En API Product Handling, 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 (configurados a continuación)", configura un producto predeterminado en Producto de API predeterminado.
  6. En API Product Widget, selecciona el elemento HTML que usan los desarrolladores para seleccionar los productos de API.
  7. Guarde la configuración.

Configuración del manejo de la URL de devolución de llamada

Si un proxy de API en tu producto de API utiliza "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 registran sus aplicaciones. En general, la URL de devolución de llamada especifica la URL de una app designada para recibir un código de autorización en nombre de la app cliente. Además, esta string de URL se usa para la validación. El cliente debe enviar esta URL a Apigee Edge cuando solicita 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 Cómo implementar 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 API, haz lo siguiente:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. En el menú de administración de Drupal, selecciona Configuración > Configuración del portal para desarrolladores > Atributos de la aplicación.
  3. En la página Configuración de la aplicación, expande el área Configuración de URL de devolución de llamada.
  4. En Administración de 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 desarrollador.
    • La URL de devolución de llamada no es obligatoria ni se muestra.
  5. Guarde la configuración.

Muestra estadísticas del uso de apps

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

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

Para habilitar las estadísticas en el portal, haz lo siguiente:

  1. Accede a tu portal como un usuario con privilegios de administrador o de creación de contenido.
  2. Selecciona Configuration > Dev Portal > Application Settings 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 de estadísticas de aplicaciones para desarrolladores.
  5. Selecciona Prueba o Producción para la opción Entorno para consultar datos de estadísticas. En el caso de un portal disponible públicamente, por lo general, deberás seleccionar Producción.
  6. Guarde la configuración.

Para mostrar las estadísticas de una app en el portal, haz lo siguiente:

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

Aprobar o revocar manualmente 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 devuelve al desarrollador la clave de API para esa app. Luego, el desarrollador usa esa clave de API para acceder a los proxies de API agrupados por el producto de API asociado con la app.

Tú controlas el proceso de aprobación de claves para cada producto de API cuando creas el producto de API:

El proceso de aprobación puede ser el siguiente:

  • 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 la clave de API de forma manual, ya sea en la IU o la API de administración perimetral, antes de que el desarrollador pueda usarla para acceder al producto de API. Más adelante, podrás revocar una clave aprobada de forma manual.

Consulta Cómo crear productos de API para obtener más información.

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

Para ver la lista de productos de API para una app y el estado de la aprobación de la clave para el 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 Weather Premium usa la aprobación manual y espera a que un administrador apruebe la clave. El producto de API gratuita utiliza la aprobación automática y se aprobó el uso de la clave para acceder.

Sigue estos pasos para aprobar o revocar una clave de forma manual:

  1. Accede a la IU de administración perimetral como un usuario con privilegios de administrador para tu organización.
  2. Selecciona Plataforma de la API en el cuadro desplegable de la esquina superior derecha.
  3. Selecciona Publicar > Apps para desarrolladores para abrir la lista de apps de 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 quieras aprobar.
  6. En la página de detalles de la app, selecciona el botón Edit en la esquina superior derecha.
  7. En la lista de productos de API para 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 Revocar en Acciones para que un producto de API revoque el acceso.

  8. Guarda la app. Ya se aprobó la clave de API.

Controlar el almacenamiento en caché de la app y los productos de API

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 se mantenga sincronizado con el backend de Edge, puedes activar de forma manual una actualización de la caché del portal, actualizar las cachés de forma automática cuando se ejecuta el trabajo cron del portal, o ambas. Por ejemplo, si configuras el trabajo cron para que se ejecute con frecuencia, como cada 5 o 10 minutos, es posible que no quieras la sobrecarga de actualizar los productos de API y las memorias caché de las apps para desarrolladores con tanta frecuencia. En esta situación, puedes activar la actualización de la caché de forma manual. Sin embargo, si el trabajo cron se ejecuta cada una o dos horas, es posible que el tiempo necesario para actualizar las memorias caché no tenga mucho impacto.

De forma predeterminada, el portal está configurado para volver a compilar las cachés de los productos de API y de las apps de desarrollador cada vez que se ejecuta cron.

Para especificar si se debe volver a compilar el producto de API y las cachés de la app de desarrollador cada vez que se ejecuta cron, haz lo siguiente:

  1. Accede a tu portal como un usuario con privilegios de administrador o de 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 Rebuild API Product and Developer App caches cada vez que se ejecute cron.
  4. Guarde la configuración.

Para actualizar las cachés de forma manual, haz lo siguiente:

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

Cómo personalizar 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 API, tal vez te convenga modificar este formulario para solicitarle al desarrollador que proporcione información adicional, como un ID de cliente, la plataforma de destino de la app u otra información. El portal te permite agregar campos nuevos a este formulario. Estos campos pueden ser los siguientes:

  • Obligatorio u opcional
  • Se muestra con diferentes elementos HTML, como cuadros de texto, botones de selección y casillas de verificación, entre otros.
  • Se puede configurar para que aparezca en cualquier parte del formulario entre el campo de URL de devolución de llamada y el campo Producto.

Si quieres obtener información para personalizar el formulario de registro de la app 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 segmentación:

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 Edge Management para acceder a esos campos desde una secuencia de comandos.

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

Los valores de campo 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 para la app en la página Mis apps.

En los procedimientos que aparecen a continuación, se describe cómo configurar los formularios de creación de apps mediante la interfaz de administrador. Un desarrollador de Drupal puede realizar personalizaciones adicionales, incluida la modificación de la página "Mis apps", mediante 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 de creación de contenido.
  2. Asegúrate de que el módulo DevConnect App Attribute Management esté habilitado.
  3. En el menú de administración de Drupal, selecciona Configuración > Configuración del portal para desarrolladores > Atributos de la app del portal para desarrolladores.
  4. Selecciona el botón Agregar atributo de la app del portal para desarrolladores 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 Requerir 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 Save changes.
  7. Selecciona el ícono de inicio > Vacía todas las cachés en el menú de Drupal.
    Es posible que debas borrar la caché del navegador antes de que aparezca el nuevo campo en el formulario.

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

  • Nombre interno = spend_platforms
  • Nombre público = Plataformas
  • Descripción = Especifica una o más plataformas para tu app.
  • Desmarque las casillas de verificación de Requerir 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 reordenar los atributos en el formulario, sigue estos pasos:

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