Descripción general de la publicación

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

La publicación es el proceso de hacer que tus API estén disponibles para los desarrolladores de apps.

Video: En el siguiente video, se proporciona una introducción de alto nivel para la publicación de la API.

Las API de publicación constan de las siguientes tareas, que se describen en este tema:

  1. Crea los productos de API en Edge que agrupan tus APIs.
  2. Registra a los desarrolladores de apps en Edge.
  3. Registra las apps de desarrollador en Edge.
  4. Proporciona documentación y asistencia comunitaria para tus API.

Tarea 1: Crea un producto de API en Edge

La primera tarea en la publicación es crear un producto de API. Un producto de API es un grupo de recursos de API que se ofrecen como un paquete para los desarrolladores de apps a fin de consumirlos. Crea productos de API con la IU o API de administración de Edge. (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 app, API y servicios de backend. El ícono y los recursos de la API aparecen destacados. Una línea punteada apunta desde el desarrollador a un ícono de una app que haya compilado el desarrollador. Las flechas desde y hacia la app muestran el flujo de solicitud y respuesta a un ícono de API, con una clave de app sobre la solicitud. El ícono y los recursos de la API aparecen destacados. Debajo del ícono de API, hay dos conjuntos de rutas de recursos agrupadas en dos productos de API: producto de ubicación y producto multimedia. El producto de Ubicación tiene recursos para /países, /ciudades y /lenguajes, y el producto de medios tiene recursos para /libros, /revistas y /películas. A la derecha de la API, se encuentran los recursos de backend a los que llama la API, incluidos una base de datos, un bus de servicios empresariales, servidores de apps y un backend genérico.

En esta figura, la API consiste en dos productos, cada uno con tres recursos de API.

Como proveedor de API, eres responsable de compilar las API y los productos de API para manejar el control de acceso, las restricciones de uso y cualquier otro requisito empresarial. Por ejemplo, puedes realizar las siguientes acciones:

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

Lo importante que debes recordar es que Edge te brinda la flexibilidad para crear productos de API que coincidan con los requisitos empresariales de tus APIs.

Para obtener más información para crear productos de API, consulta Crea productos de API.

Tarea 2: Registra un desarrollador de apps en Edge

Un desarrollador crea las aplicaciones que consumen tus API. Un desarrollador de apps se registra en Apigee Edge antes de que pueda registrar su app. Cuando registra su app, recibe una clave de API que le otorga acceso a ella.

A través del proceso de registro de aplicaciones, puedes controlar quién tiene acceso a tus API. En cualquier momento, puedes borrar un desarrollador de app, lo que invalida todas las claves de API asociadas con ese desarrollador y, por lo tanto, no se le permite negar dicho acceso a tus API.

Diagrama de secuencia de izquierda a derecha que muestra un desarrollador, una app, API y servicios de backend. El ícono del desarrollador está destacado. Una línea punteada apunta desde el desarrollador destacado a un ícono de una app que haya compilado el desarrollador. Las flechas desde y hacia la app muestran el flujo de solicitud y respuesta a un ícono de API, con una clave de app sobre la solicitud. Debajo del ícono de API, hay dos conjuntos de rutas de recursos agrupadas en dos productos de API: producto de ubicación y producto multimedia. El producto de Ubicación tiene recursos para /países, /ciudades y /lenguajes, y el producto de medios tiene recursos para /libros, /revistas y /películas. A la derecha de la API, se encuentran los recursos de backend a los que llama la API, incluidos una base de datos, un bus de servicios empresariales, servidores de apps y un backend genérico.

Como proveedor de API, decides cómo registrar a los desarrolladores. Por ejemplo, puedes usar un proceso de registro manual que requiere que un desarrollador potencial se comunique con tu organización para realizar el registro. El desarrollador potencial debe proporcionar toda la información necesaria, como una dirección de correo electrónico, un nombre y apellido, y un nombre de empresa. Si apruebas la solicitud del desarrollador, puedes usar la IU de administración de Edge para registrar al desarrollador de forma manual. Consulta Cómo administrar desarrolladores de apps para obtener más información.

Apigee también proporciona herramientas que puedes usar para automatizar el proceso de registro de desarrolladores. Por ejemplo:

  • Usa la API de administración de Apigee Edge para integrar la funcionalidad de registro en tu sitio web existente. La API de Edge Management es una API de REST que puedes usar para realizar todos los aspectos del proceso de registro de desarrolladores. Consulta Cómo usar la API de administración de Edge para publicar APIs para obtener más información.
  • Usa el portal de servicios para desarrolladores de Apigee para registrar a los desarrolladores. El portal tiene compatibilidad integrada con el registro de desarrolladores, pero también tiene muchas otras funciones para admitir tus APIs. Consulta ¿Qué es un portal para desarrolladores? para obtener más información.

Tarea 3: Registra una app para desarrolladores en Edge

Antes de que una app pueda acceder a tus APIs, esta debe estar registrada en Edge. Sin embargo, solo un desarrollador registrado puede registrar una app en Edge.

Diagrama de secuencia de izquierda a derecha que muestra un desarrollador, una app, API y servicios de backend. Se destacan las flechas de la app, la solicitud y respuesta, y la clave de API. Una línea punteada apunta desde el desarrollador a un ícono de una app que haya compilado el desarrollador. Las flechas desde y hacia la app muestran el flujo de solicitud y respuesta a un ícono de API, con una clave de app sobre la solicitud. El ícono y los recursos de la API aparecen destacados. Debajo del ícono de API, hay dos conjuntos de rutas de recursos agrupadas en dos productos de API: producto de ubicación y producto multimedia. El producto de Ubicación tiene recursos para /países, /ciudades y /lenguajes, y el producto de medios tiene recursos para /libros, /revistas y /películas. A la derecha de la API, se encuentran los recursos de backend a los que llama la API, incluidos una base de datos, un bus de servicios empresariales, servidores de apps y un backend genérico.

En el momento del registro de la app, el desarrollador selecciona uno o más productos de API. Por ejemplo, puedes publicar varios productos de API que corresponden a diferentes tipos de servicios y planes de precios. Luego, el desarrollador de la app puede elegir y elegir de la lista de productos de API disponibles.

En respuesta al registro de la app en Edge, Edge asigna una clave de API única. La app debe pasar esa clave de API como parte de cada solicitud a un recurso de la API. La clave se autentica y, si es válida, se otorga la solicitud. En cualquier momento, como proveedor de servicios, puedes revocar la clave para que la aplicación ya no pueda acceder a tus API.

Como proveedor de API, decides cómo quieres registrar las apps. Intenta hacer lo siguiente:

  • Usa un proceso manual que requiera un desarrollador para contactar a tu organización a fin de registrar su app. En respuesta, debes enviar al desarrollador la clave de API, posiblemente por correo electrónico.
  • Usa la API de Edge Management para integrar la funcionalidad de registro de apps y la entrega de claves en tu sitio web.
  • En el caso de las cuentas pagadas de Edge, usa el portal de servicios para desarrolladores de Apigee, que es compatible con el registro de apps y la entrega de claves de API.

Para obtener más información, consulta Registra apps y administra claves de API.

Tarea 4: Documenta tus API

Un aspecto importante que debes tener en cuenta para publicar productos de API es proporcionar documentación y un mecanismo de comentarios para desarrolladores. Los portales para desarrolladores con funciones de publicación social se usan cada vez más para la comunicación con la comunidad de desarrollo. 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, así como las características de asistencia al cliente.

Diagrama de secuencia de izquierda a derecha que muestra un desarrollador, una app, API y servicios de backend. El ícono del desarrollador está destacado. Debajo del desarrollador hay un cuadro que representa un portal para desarrolladores. El portal contiene documentación de API, muestras, instructivos, referencia de la API y más. El portal también contiene blogs, foros y un portal de asistencia. Una línea punteada apunta desde el desarrollador destacado a un ícono de una app que haya compilado el desarrollador. Las flechas desde y hacia la app muestran el flujo de solicitud y respuesta a un ícono de API, con una clave de app sobre la solicitud. Debajo del ícono de API, hay dos conjuntos de rutas de recursos agrupadas en dos productos de API: producto de ubicación y producto multimedia. El producto de Ubicación tiene recursos para /países, /ciudades y /lenguajes, y el producto de medios tiene recursos para /libros, /revistas y /películas. A la derecha de la API, se encuentran los recursos de backend a los que llama la API, incluidos una base de datos, un bus de servicios empresariales, servidores de apps y un backend genérico.

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

SmartDocs te permite documentar tus API en el portal de servicios para desarrolladores, de manera que la documentación de la API sea completamente interactiva. La documentación interactiva con SmartDocs significa que los usuarios del portal pueden realizar las siguientes acciones:

  • Lee acerca de la API
  • Envía una solicitud a la API.
  • Visualiza una respuesta en vivo que muestra la API

Por ejemplo, en la siguiente imagen, se muestra una API documentada en el portal con SmartDocs. Esta API proporciona información del clima para una ubicación específica:

Un tema de método de la API de SmartDocs que te permite llamar a una API del clima haciendo clic en un botón del tema.

El desarrollador ingresa un valor para el parámetro de consulta "w" para especificar la ubicación y, luego, hace clic en el botón Send the request para ver la solicitud y la respuesta en vivo. Cuando creas una documentación interactiva sobre tus APIs, facilitas que el usuario del portal aprenda sobre ellas, las pruebe y las evalúe.

La API de administración de Edge es una API de REST que te permite acceder a los servicios de API con cualquier cliente HTTP. Apigee usa SmartDocs para crear documentación interactiva para la API de administración de Edge. Consulta esa documentación de la API aquí.

Para obtener más información, consulta Cómo usar SmartDocs para documentar APIs.