Estás viendo la documentación de Apigee Edge.
Ve a la
documentación de Apigee X. info
Los portales para desarrolladores con funciones de publicación social se usan cada vez más para la comunicación con la comunidad de desarrolladores. Esto incluye la comunicación de contenido estático, como la documentación y las condiciones de uso de la API, así como contenido dinámico que aporta la comunidad, como blogs y foros.
Como proveedor de APIs, necesitas una forma de exponer tus APIs, educar a los desarrolladores sobre ellas, registrarlos y permitir que registren apps. Exponer tus APIs a los desarrolladores es solo una parte de la creación de una comunidad verdaderamente dinámica. También necesitas una forma para que tu comunidad de desarrolladores proporcione comentarios, realice solicitudes de asistencia y funciones, y envíe su propio contenido al que otros desarrolladores puedan acceder.
Apigee Edge te proporciona un portal de servicios para desarrolladores que puedes usar para compilar y lanzar tu propio sitio web personalizado y proporcionar todos estos servicios a tu comunidad de desarrollo. Cada cliente de Edge puede crear su propio portal para desarrolladores, ya sea en la nube o de forma local.
En el siguiente video, se presenta el portal de servicios para desarrolladores de Apigee.
En la siguiente figura, se muestra la página principal del portal de desarrolladores predeterminado:
El portal para desarrolladores es, en esencia, un sistema de administración de contenido (CMS) basado en el proyecto de código abierto Drupal (http://www.drupal.org). Drupal proporciona un conjunto principal de funciones en forma de módulos que te permiten crear y administrar el contenido de los sitios web con facilidad.
El portal para desarrolladores listo para usar te permite crear documentación de API, es compatible con los blogs y proporciona foros de conversación. También puedes personalizar el portal para desarrolladores para satisfacer tus requisitos específicos. La personalización te permite modificar el aspecto del portal y la forma en que los desarrolladores interactúan con él.
Usas el menú de Drupal para realizar la mayor parte de la personalización. Si accedes al portal como usuario con privilegios de administrador, el menú de Drupal aparecerá en la parte superior de cada página del portal:
La administración controla el proceso en el que los desarrolladores solicitan acceso al portal, cómo los desarrolladores registran las apps que acceden a tus APIs, cómo asignas a los desarrolladores roles y permisos específicos relacionados con tus APIs, y cuándo revocar el acceso de los desarrolladores a las APIs.
También puedes usar el portal para desarrolladores para configurar y controlar la monetización. La monetización les brinda a los desarrolladores acceso de autoservicio a Facturación y informes, Catálogo y planes, y parámetros de configuración específicos de monetización a través del portal para desarrolladores.
Tipos de usuarios del portal
En la siguiente imagen, se muestran dos tipos de usuarios del portal:
- Los desarrolladores conforman la comunidad de usuarios que compilan apps con tus APIs. Los desarrolladores de apps usan el portal para obtener información sobre tus APIs a través de SmartDocs, registrar una cuenta en el portal, registrar apps que usan tus APIs, interactuar con la comunidad de desarrolladores y ver información estadística sobre el uso de sus apps en un panel.
-
El equipo de la API es el proveedor de la API que crea el contenido del portal, pone sus APIs a disposición de los desarrolladores de apps, proporciona documentación de la API y un mecanismo para que los desarrolladores registren apps y obtengan claves de API. El equipo de la API realiza la configuración básica del portal para desarrolladores para lo siguiente:
- Configura solicitudes automáticas o manuales para las claves de API
- Mantener la documentación, los foros y los blogs de la API y, de manera opcional, revisar todos los cambios
- Controla los comentarios de los usuarios y la moderación del foro
- Aplica el control de acceso basado en roles (RBAC) para controlar el acceso a las funciones del portal. Por ejemplo, un administrador puede habilitar controles para permitir que un usuario registrado cree publicaciones en el foro o use consolas de prueba.
- Personaliza las notificaciones por correo electrónico para administradores y desarrolladores para la creación y aprobación de usuarios
- Personalizar formularios web, como las páginas de contacto
En esta figura, no se muestra un tercer tipo de usuario del portal: el administrador de productos de API. El administrador del producto de la API es responsable de definir cómo el equipo de la API compila el portal, lo que incluye lo siguiente:
- Define cómo se empaquetan las APIs en productos
- Definición de las reglas para la aprobación de apps
- Si la monetización está habilitada en el portal, define los planes de precios y facturación para los productos de API. Para obtener más información sobre la monetización, consulta la descripción general de la monetización.
Personaliza el portal para desarrolladores
Como proveedor de APIs, considera cómo personalizar el portal para desarrolladores para que se adapte mejor a tus APIs y para proporcionar la información necesaria para que tu comunidad de desarrolladores las use. Estas son algunas consideraciones para tu portal personalizado:
- Acceso sencillo a tus APIs
- Documentación, como guías prácticas y documentos de referencia
- Contenido que aporta la comunidad, como blogs y foros de debate
- Código de muestra
- Un proceso de registro sencillo en el que se pueden aprobar rápidamente los desarrolladores, las apps y las APIs nuevos
- Derechos y credenciales administrados
- Control de acceso por niveles
- Un aspecto que combine con tu organización
El portal viene predefinido con una configuración básica. Por ejemplo, el portal está configurado de forma predeterminada para permitir que cualquier persona se registre como desarrollador, pero un administrador debe aprobar cada registro antes de que el desarrollador pueda acceder al portal. Después de la aprobación del registro, el desarrollador puede registrar una app para solicitar una clave de API y usar el portal para acceder a los recursos de la API.
Los pasos del proceso de registro predeterminado son los siguientes:
- El desarrollador se registra a través del portal para desarrolladores. En respuesta, el portal envía un correo electrónico a los administradores para que aprueben la cuenta.
- Un administrador aprueba la cuenta y se le envía un correo electrónico al desarrollador para informarle que ahora puede acceder.
- El desarrollador registra una app y selecciona los productos de API que usa. En respuesta, el portal asigna una clave de API única a la app.
- El desarrollador pasa la clave de API cuando realiza solicitudes a tu API.
Esta experiencia lista para usar es altamente personalizable. Por ejemplo, puedes anular el esquema de registro y autorización predeterminado para que un desarrollador nuevo se apruebe automáticamente y acceda después del registro. También puedes exigir que el desarrollador acepte un conjunto de términos y condiciones antes de que pueda acceder por primera vez.
También tienes el control total sobre el contenido disponible en el portal para desarrolladores. De forma predeterminada, el portal para desarrolladores presenta contenido de muestra, como documentación de la API, publicaciones de blog y debates del foro. Puedes proporcionar tu propio contenido y personalizar el aspecto de cada tipo de contenido.
Para obtener más información, consulta Cómo personalizar el aspecto.
Administra el portal para desarrolladores
Los desarrolladores usan tu portal para desarrolladores para acceder a tu API y usarla. Los administradores realizan tareas de administración de cuentas, como las siguientes:
- Personalizar el proceso de registro de desarrolladores, incluidos los campos de registro, el Captcha integrado y la aprobación automática o manual
- Agregar o aprobar desarrolladores De forma predeterminada, cualquier desarrollador puede registrarse a través del portal para desarrolladores, pero debe ser aprobado por un administrador a través de la interfaz de usuario del portal para desarrolladores. Los administradores también pueden crear desarrolladores directamente en el portal. Luego, el portal le envía automáticamente un correo electrónico al desarrollador para informarle que se creó una cuenta para él.
- Modificar la cuenta de un desarrollador. Por ejemplo, los administradores pueden cambiar el estado de la cuenta del usuario de activo a bloqueado, o bien cambiar la información del perfil del desarrollador, como el nombre de la empresa.
- Quitar a un desarrollador Los administradores pueden inhabilitar o borrar la cuenta de un desarrollador.
- Asignación de roles y permisos: Los administradores pueden asignar un rol específico a una cuenta de desarrollador. Un rol está asociado con varios permisos, como el permiso para crear libros o otro contenido. También puedes cambiar los permisos asociados con un rol o crear roles nuevos.
Para obtener más información, consulta Cómo agregar y administrar cuentas de usuario.
Resumen de las funciones del portal para desarrolladores
En la siguiente tabla, se incluye un resumen de las funciones del portal para desarrolladores:
| Función | Detalles |
|---|---|
| Navegadores compatibles |
Consulta Software y versiones compatibles. |
|
Registro de usuario |
|
|
Administración de usuarios |
|
|
Aspecto del portal |
|
|
Administración de contenido y comunidad |
|
|
Permisos |
|
|
Administración de claves de API |
|
|
Correo electrónico |
|
|
Blogs |
|
|
Foros |
|
|
Documentación |
|
|
Menús |
|
|
Buscar |
|
|
Verificador de vínculos |
|