Estás consultando la documentación de Apigee Edge.
Consulta la
documentación de Apigee X. Información
Los portales para desarrolladores con funciones de publicación en redes sociales se usan cada vez más para comunicarse con la comunidad de desarrolladores. Esto incluye la comunicación de contenido estático, como la documentación de la API y las Condiciones de uso, además de contenido dinámico con contribuciones de la comunidad, como blogs y foros.
Como proveedor de APIs, necesitas una forma de exponer tus APIs, educar a los desarrolladores sobre ellas, registrar desarrolladores y permitir que los desarrolladores registren apps. Exponer tus APIs a los desarrolladores es solo parte de la creación de una comunidad verdaderamente dinámica. También necesitas una manera para que tu comunidad de desarrolladores proporcione comentarios, realice solicitudes de funciones y asistencia, y envíe su propio contenido al que puedan acceder otros desarrolladores.
Apigee Edge te proporciona un portal de servicios para desarrolladores que puedes usar a fin de compilar y lanzar tu propio sitio web personalizado y brindar 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 imagen, se muestra la página principal del portal para desarrolladores predeterminado:
El portal para desarrolladores es básicamente un sistema de administración de contenido (CMS) basado en el proyecto de código abierto de Drupal (http://www.drupal.org). Drupal proporciona un conjunto de funciones principales en forma de módulos que te facilitan compilar el contenido para sitios web, además de administrarlos.
Desde el primer momento, el portal para desarrolladores te permite crear documentación de API, admite blogs y proporciona foros de conversación. También puedes personalizar el portal para desarrolladores a fin de que cumpla con tus requisitos específicos. La personalización te permite modificar el aspecto del portal y también la forma en que los desarrolladores interactúan con él.
Utilizas el menú de Drupal para realizar la mayor parte de la personalización. Si accedes al portal como un 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 registran las apps que acceden a tus APIs, cómo les asignas funciones 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 a fin de configurar y controlar la monetización. La monetización les brinda a los desarrolladores acceso de autoservicio a la facturación y los informes, el catálogo y los planes, y a la configuración específica de la monetización mediante el portal para desarrolladores.
Tipos de usuarios del portal
En la siguiente imagen, se muestran dos tipos de usuarios del portal:
- Los desarrolladores forman 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 su uso de apps en un panel.
-
El equipo de API es el proveedor de la API que crea contenido del portal, pone sus APIs a disposición de los desarrolladores de apps, proporciona documentación sobre ellas y brinda un mecanismo para que los desarrolladores registren apps y obtengan claves de API. El equipo de API realiza la configuración básica
del portal para desarrolladores con los siguientes objetivos:
- Configura solicitudes automáticas o manuales para 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 de foros
- Aplicar 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 los administradores y los desarrolladores sobre la creación y la 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 la API. El administrador de productos de API es responsable de definir cómo crea el portal el equipo de API, incluido lo siguiente:
- Definición de cómo se empaquetan las APIs en los productos
- Define las reglas para la aprobación de apps
- Definir los precios y los planes de facturación de los productos de API si la monetización está habilitada Para obtener más información sobre la monetización, consulta Descripción general de la monetización.
Personaliza el portal para desarrolladores
Como proveedor de APIs, considera cómo personalizar el portal para desarrolladores de modo que se adapte mejor a tus APIs y proporcionar la información necesaria para que tu comunidad de desarrolladores use tus APIs. Algunas consideraciones para tu portal personalizado incluyen lo siguiente:
- Fácil acceso a tus APIs
- Documentación, como guías prácticas y documentos de referencia
- Contenido aportado por la comunidad, como blogs y foros de debate
- Código de muestra
- Un proceso de registro sencillo en el que los desarrolladores, las apps y las APIs nuevos pueden aprobarse rápidamente
- Credenciales y derechos administrados
- Control de acceso por niveles
- Un diseño que se adapte a tu organización
El portal viene predefinido con una configuración básica. Por ejemplo, de manera predeterminada, el portal está configurado para permitir que cualquier persona se registre como desarrollador, pero un administrador debe aprobar cada registro para que el desarrollador pueda acceder al portal. Luego de la aprobación del registro, el desarrollador puede registrar una app para solicitar una clave de API y usar el portal a fin de 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 se apruebe y acceda automáticamente a un desarrollador nuevo después del registro. También puedes pedirle al desarrollador que acepte un conjunto de Términos y Condiciones para poder acceder por primera vez.
También tienes el control total del contenido disponible en el portal para desarrolladores. Desde el primer momento, el portal para desarrolladores presenta contenido de muestra, como documentación de la API, entradas de blog y debates de foros. Puedes proporcionar tu propio contenido y personalizar el aspecto de cada tipo de contenido.
Para obtener más información, consulta Cómo personalizar la apariencia.
Administra el portal para desarrolladores
Los desarrolladores usan tu portal para desarrolladores a fin de acceder a tu API y usarla. Los administradores realizan las siguientes tareas de administración de la cuenta:
- Personalización del proceso de registro del desarrollador, incluidos los campos de registro, el captcha integrado y la aprobación manual o automática
- Agregar o aprobar desarrolladores De forma predeterminada, cualquier desarrollador puede registrarse a través del portal para desarrolladores, pero debe contar con la aprobación de 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 enviará un correo electrónico automático al desarrollador para informarle que se le creó una cuenta.
- Modificar la cuenta de un desarrollador Por ejemplo, los administradores pueden cambiar el estado de la cuenta del usuario de activa a bloqueada, o bien cambiar la información del perfil del desarrollador, como el nombre de la empresa.
- Quitar un desarrollador Los administradores pueden inhabilitar o borrar una cuenta de desarrollador.
- Asignación de funciones y permisos: Los administradores pueden asignar una función específica a una cuenta de desarrollador. Un rol se asocia con varios permisos, como los permisos para crear libros y otro contenido. También puedes cambiar los permisos asociados con un rol o crear otros 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:
| Atributo | Detalles |
|---|---|
| Navegadores compatibles |
Consulta Software y versiones compatibles. |
|
Registro de usuario |
|
|
Administración de usuarios |
|
|
Apariencia del portal |
|
|
Administración de contenido y de la comunidad |
|
|
Permisos |
|
|
Administración de claves de API |
|
|
Correo electrónico |
|
|
Blogs |
|
|
Foros |
|
|
Documentación |
|
|
Menús |
|
|
Buscar |
|
|
Verificador de vínculos |
|