Información general sobre la publicación

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Publicar es el proceso de poner tus APIs a disposición de los desarrolladores de aplicaciones para que las consuman.

Vídeo: en el siguiente vídeo se ofrece una introducción general a la publicación de APIs.

Para publicar APIs, debes realizar las siguientes tareas, que se describen en este tema:

  1. Crea los productos de API que agrupen tus APIs.
  2. Registra desarrolladores de aplicaciones.
  3. Registra las aplicaciones de desarrolladores.
  4. Proporciona documentación y asistencia de la comunidad para tus APIs.

Tarea 1: Crear un producto de API

La primera tarea para publicar es crear un producto de API. Un producto de API es una colección de recursos de API que se ofrece como paquete a los desarrolladores de aplicaciones para que los consuman. Crea productos de API mediante la API o la interfaz de usuario de Apigee. (Consulta ¿Qué es un producto de API? para obtener más información sobre los productos de API).

Diagrama de secuencia de izquierda a derecha que muestra un desarrollador, una aplicación, APIs y servicios de backend. El icono y los recursos de la API se resaltan. Una línea de puntos apunta del desarrollador a un icono de una aplicación que ha creado. Las flechas que van y vuelven de la aplicación muestran el flujo de solicitudes y respuestas a un icono de API, con una clave de aplicación situada encima de la solicitud. El icono y los recursos de la API se resaltan. Debajo del icono de la API, hay dos conjuntos de rutas de recursos agrupados en dos productos de API: producto de ubicación y producto multimedia. El producto Location tiene recursos para /countries, /cities y /languages, y el producto Media tiene recursos para /books, /magazines y /movies. A la derecha de la API se encuentran los recursos de backend a los que llama la API, como una base de datos, un bus de servicios empresariales, servidores de aplicaciones y un backend genérico.

En esta figura, la API consta de dos productos, cada uno de los cuales contiene tres recursos de API.

Como proveedor de APIs, eres responsable de crear las APIs y los productos de APIs para gestionar el control de acceso, las restricciones de uso y cualquier otro requisito empresarial. Por ejemplo, puedes hacer lo siguiente:

  • Lanza un producto de API gratuito que permita el acceso de solo lectura a sus recursos de API.
  • Lanza un segundo producto de API a un precio bajo que permita el acceso de lectura y escritura a los mismos recursos de API que la versión gratuita, pero con un límite de acceso bajo, como 1000 solicitudes al día.
  • Lanza un tercer producto de API a un precio más alto que permita el acceso de lectura y escritura al mismo recurso de API, pero con un límite de acceso alto.

Lo importante es recordar que Apigee te ofrece la flexibilidad necesaria para crear productos de API que se ajusten a los requisitos empresariales de tus APIs.

Para obtener más información sobre cómo crear productos de API, consulta Gestionar productos de API.

Tarea 2: Registrar un desarrollador de aplicaciones

Un desarrollador crea las aplicaciones que consumen tus APIs. Un desarrollador de aplicaciones se registra en Apigee antes de poder registrar su aplicación. Cuando registra su aplicación, recibe una clave de API que le dará acceso a la API.

A través del proceso de registro de aplicaciones, puedes controlar quién tiene acceso a tus APIs. En cualquier momento, puedes eliminar a un desarrollador de aplicaciones, lo que invalidará todas las claves de API asociadas a ese desarrollador y, por lo tanto, le denegará el acceso a tus APIs.

Diagrama de secuencia de izquierda a derecha que muestra un desarrollador, una aplicación, APIs y servicios de backend. El icono de desarrollador aparece resaltado. Una línea de puntos apunta del desarrollador destacado al icono de una aplicación que ha creado. Las flechas que van y vuelven de la aplicación muestran el flujo de solicitudes y respuestas a un icono de API, con una clave de aplicación situada encima de la solicitud. Debajo del icono de la API, hay dos conjuntos de rutas de recursos agrupados en dos productos de API: producto de ubicación y producto multimedia. El producto Location tiene recursos para /countries, /cities y /languages, y el producto Media tiene recursos para /books, /magazines y /movies. A la derecha de la API se encuentran los recursos de backend a los que llama la API, como una base de datos, un bus de servicios empresariales, servidores de aplicaciones y un backend genérico.

Como proveedor de APIs, usted decide cómo registrar a los desarrolladores. Por ejemplo, puedes usar un proceso de registro manual que requiera que un desarrollador potencial se ponga en contacto con tu organización para registrarse. El posible desarrollador debe proporcionar toda la información necesaria, como una dirección de correo electrónico, el nombre y los apellidos. Si apruebas la solicitud del desarrollador, puedes usar la interfaz de usuario de Apigee para registrarlo manualmente. Consulta más información en el artículo Registrar desarrolladores de aplicaciones.

Tarea 3: Registrar una aplicación de desarrollador

Para que una aplicación pueda acceder a tus APIs, debe estar registrada. Sin embargo, solo un desarrollador registrado puede registrar una aplicación.

Diagrama de secuencia de izquierda a derecha que muestra un desarrollador, una aplicación, APIs y servicios de backend. Se resaltan las flechas de la aplicación, la solicitud o respuesta y la clave de API. Una línea de puntos apunta del desarrollador a un icono de una aplicación que ha creado. Las flechas que van y vuelven de la aplicación muestran el flujo de solicitudes y respuestas a un icono de API, con una clave de aplicación situada encima de la solicitud. El icono y los recursos de la API se resaltan. Debajo del icono de la API, hay dos conjuntos de rutas de recursos agrupados en dos productos de API: producto de ubicación y producto multimedia. El producto Location tiene recursos para /countries, /cities y /languages, y el producto Media tiene recursos para /books, /magazines y /movies. A la derecha de la API se encuentran los recursos de backend a los que llama la API, como una base de datos, un bus de servicios empresariales, servidores de aplicaciones y un backend genérico.

En el momento de registrar la aplicación, el desarrollador selecciona uno o varios productos de API. Por ejemplo, puedes publicar varios productos de API que correspondan a diferentes tipos de servicios y planes de precios. El desarrollador de la aplicación puede elegir los productos de API que quiera de la lista disponible.

Cuando registras la aplicación en Apigee, Apigee le asigna una clave de API única. La aplicación debe enviar esa clave de API como parte de cada solicitud a un recurso de API. La clave se autentica y, si es válida, se concede la solicitud. En cualquier momento, tú, como proveedor de servicios, puedes revocar la clave para que la aplicación ya no pueda acceder a tus APIs.

Como proveedor de APIs, usted decide cómo quiere registrar las aplicaciones. Puedes hacer lo siguiente:

  • Utilizar un proceso manual que requiera que un desarrollador se ponga en contacto con tu organización para registrar su aplicación. En respuesta, le enviarías la clave de API al desarrollador, posiblemente por correo electrónico.
  • Usa la API de Apigee para integrar la función de registro de aplicaciones y la entrega de claves en tu sitio web.
  • Si tienes una cuenta de pago de Apigee, usa el portal Apigee Developer Services, que incluye compatibilidad con el registro de aplicaciones y la entrega de claves de API.

Para obtener más información, consulta Registrar aplicaciones y gestionar claves de API.

Tarea 4: Documenta tus APIs

Un aspecto importante a tener en cuenta al publicar productos de API es proporcionar documentación y un mecanismo para recibir comentarios de los desarrolladores. Los portales para desarrolladores con funciones de publicación en redes sociales se utilizan 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 las APIs y los términos de uso, así como contenido dinámico aportado por la comunidad, como blogs y foros, y funciones de asistencia al cliente.

Diagrama de secuencia de izquierda a derecha que muestra un desarrollador, una aplicación, APIs y servicios de backend. El icono de desarrollador aparece resaltado. Debajo del desarrollador hay un cuadro que representa un portal para desarrolladores. El portal contiene documentación de las APIs, ejemplos, tutoriales, referencias de las APIs y más. El portal también contiene blogs, foros y un portal de asistencia. Una línea de puntos apunta del desarrollador destacado a un icono de una aplicación que ha creado. Las flechas que van y vuelven de la aplicación muestran el flujo de solicitudes y respuestas a un icono de API, con una clave de aplicación situada encima de la solicitud. Debajo del icono de la API, hay dos conjuntos de rutas de recursos agrupados en dos productos de API: producto de ubicación y producto multimedia. El producto Location tiene recursos para /countries, /cities y /languages, y el producto Media tiene recursos para /books, /magazines y /movies. A la derecha de la API se encuentran los recursos de backend a los que llama la API, como una base de datos, un bus de servicios empresariales, servidores de aplicaciones y un backend genérico.

Puedes crear tu propio sitio web para implementar la documentación o, si tienes una cuenta de pago de Apigee, puedes usar el portal de servicios para desarrolladores de Apigee. El portal incluye asistencia para documentación, blogs, foros y otros tipos de contenido necesarios para dar soporte a tu comunidad de desarrolladores.

SmartDocs te permite documentar tus APIs en el portal de servicios para desarrolladores de forma que la documentación de las APIs sea totalmente interactiva. La documentación interactiva con SmartDocs permite a los usuarios del portal:

  • Información sobre la API
  • Enviar una solicitud activa a la API
  • Ver una respuesta en directo devuelta por la API

Para obtener más información, consulta las siguientes secciones: