Catalog

La página Catalog muestra la documentación de sus APIs, organizada por producto.

Siga los pasos a continuación para descargar un swagger.

  1. Acceda a su Developer Portal.
    Entre directamente al enlace o acceda a Portal Manager y haga clic en Portal  Appearance para obtener el enlace.

  2. Haga clic en APIs  Catalog, en la esquina superior derecha de la pantalla.
    Es necesario que esté conectado.

    detalle del encabezado del developer portal con indicación del enlace al catalog

  3. Seleccione el producto deseado.
    Si es necesario, utilice el campo de búsqueda por API o el filtro por productos.

  4. Haga clic en el botón DOCUMENTATION de la API.
    Las imágenes a continuación son solo ilustrativas. Los colores, logotipos y otros elementos pueden variar de acuerdo con la personalización hecha en Portal > Appearance de Portal Manager.

    detalle de la pantalla del developer portal, producto y botón documentation

  5. En la parte superior derecha, seleccione la revisión del documento y haga clic en DOWNLOAD SWAGGER.

    detalle de la pantalla catalog con opciones de document revision y botón de descarga

Accesos

Para ver la documentación de una API del catálogo es necesario:

  1. que la ruta API Catalog esté definida en al menos un rol;

  2. que el producto y la API estén definidos con ese rol;

  3. que el usuario posea un rol con las características 1 y 2.

Administrador, si un usuario no ve un producto o API en el catálogo de APIs, verifique:

Registrando y editando roles para un producto

Administrador, siga estos pasos para definir qué roles pueden acceder al Catálogo de APIs:

  1. En Portal Manager, haga clic en Products, ubicado en el menú lateral izquierdo o en la pantalla inicial.
    pantalla inicial con énfasis en products

  2. Haga clic en el ícono ícono de un lápiz del producto que desea editar.

  3. En Roles, seleccione los roles que tendrán acceso a los productos del catálogo de APIs.
    paso 1 del registro de productos con roles en énfasis

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]