Skip to main content

Api Catalog

" Encuentra y utiliza las APIs que necesitas "

¿Por qué es importante el API Catalog? El API Catalog es fundamental para la administración y el uso de APIs dentro del portal, proporcionando a los desarrolladores una visión completa de todos los recursos disponibles. Esta herramienta facilita la búsqueda, revisión y prueba de APIs, asegurando una experiencia de desarrollo rápida y organizada al tener toda la información en un solo lugar.

Esta interfaz está diseñada para proporcionar a los desarrolladores un espacio centralizado donde pueden explorar, revisar y acceder a todas las APIs disponibles en el portal. Organiza cada API con información detallada, como descripciones, especificaciones y guías de uso, facilitando la búsqueda y selección de recursos adecuados para el desarrollo.

Con esta interfaz, los desarrolladores pueden gestionar y utilizar las APIs de manera eficiente, optimizando el flujo de trabajo y asegurando una experiencia organizada y productiva.

D2

A través de esta funcionalidad, los desarrolladores pueden explorar y acceder fácilmente a todas las APIs disponibles en el portal. Esto les permite revisar detalles clave de cada API, como su descripción, especificaciones y endpoints, facilitando la integración y optimizando su uso en aplicaciones. Esta funcionalidad centraliza el acceso a las APIs, mejorando el flujo de trabajo y permitiendo una gestión eficiente y organizada de los recursos disponibles.

La interfaz ofrece dos funcionalidades presentadas en pestañas seleccionables:

  • List of API Catalogs
  • Categories

tal como se muestra en la siguiente figura:

D2

List of API Catalogs:

Esta funcionalidad muestra una lista completa de todas las APIs disponibles, organizada para facilitar su acceso y revisión.

D2

Al seleccionarla, se despliega una lista de APIs con una visión clara de información clave, tales como:

  • Published: Indica si la API está publicada y disponible para su uso.
  • Title to display: Título de la API que se mostrará para su identificación.
  • Image to Show: Imagen asociada a la API para visualización rápida.
  • Categories: Categorías a las que pertenece la API, facilitando su clasificación y búsqueda.
  • Actions: Opciones como: Edit y Delete que permiten gestionar los elementos de cada APIs de manera eficiente.

Esta organización permite a los desarrolladores explorar y localizar fácilmente las APIs necesarias para sus proyectos, optimizando el flujo de trabajo.

Opciones sobre "List of API Catalogs":

  • New Catalog

    La interfaz "List of API Catalogs" ofrece la funcionalidad de New Catalog, permitiendo a los desarrolladores añadir nuevas APIs al catálogo.

    Para acceder, se debe seleccionar el botón ubicado en la parte superior derecha, como se muestra en la siguiente figura:

    D2

    Al seleccionar esta opción, se despliega un formulario, como muestra la siguiente figura:

    D2

    donde se pueden configurar detalles claves del nuevo catálogo, como:

    • API Details: Opción para seleccionar el estado de la API, entre Published y Unpublished.
    • Title to display: Título que se mostrará para identificar la API.
    • API Image: Imagen asociada para facilitar la visualización de la API.
    • Description to Show: Breve descripción que destaca el propósito de la API.
    • Categories: Clasificación de la API para facilitar su organización y búsqueda.
    • Documentación API: Enlace o sección de acceso a la documentación completa de la API.
    • Visibility: Configuración de visibilidad que controla el acceso público o restringido al catálogo.

    Esta funcionalidad permite a los desarrolladores expandir y organizar el catálogo de APIs de forma estructurada, optimizando el acceso y la documentación de los recursos disponibles.

  • Edit

    La opción Edit en List of API Catalogs permite modificar los detalles de una API existente en el catálogo.

    Al seleccionar esta opción, se despliega un formulario con la configuración actual de la API, donde los desarrolladores pueden ajustar información como:API Details, Title to display, API Image, Description to Show, Categories, Documentación API, Visibility

    D2

    Esta funcionalidad facilita la actualización y personalización de las APIs en el catálogo, asegurando que la información esté siempre actualizada y sea relevante para los usuarios.

  • Delete

    La opción Delete permite eliminar una API del catálogo.

    Al seleccionar esta opción, se despliega un mensaje de confirmación para asegurar que se desea proceder con la eliminación.

    D2

    Una vez confirmada, la API será eliminada del sistema, lo que ayuda a mantener el catálogo organizado y libre de recursos obsoletos o innecesarios.

Categories:

Esta funcionalidad permite navegar por las APIs agrupadas en categorías, optimizando la búsqueda y facilitando la identificación de APIs específicas según su función o uso.

D2

Al seleccionarla, se despliega una lista de Categorías con una visión clara de información clave, tales como:

  • Name: Nombre de la categoría para identificarla rápidamente.
  • Actions: Opciones como: Edit y Delete que permiten modificar o eliminar categorías de forma sencilla.

Esta organización permite a los desarrolladores encontrar y administrar APIs de forma ágil, asegurando un acceso ordenado y estructurado a los recursos según su propósito y funcionalidad.

Opciones sobre "Categories":

  • New Category

    La interfaz "Categories" ofrece la funcionalidad de New Category, permitiendo a los desarrolladores crear nuevas categorías para organizar las APIs en el catálogo.

    Para acceder, se debe seleccionar el botón ubicado en la parte superior derecha, como se muestra en la siguiente figura:

    D2

    Al seleccionar esta opción, se despliega un formulario, como muestra la siguiente figura:

    D2

    donde se pueden configurar detalles clave de la nueva categoría, como:

    • Name: Nombre de la categoría para su identificación rápida y precisa.

    Esta funcionalidad permite a los desarrolladores organizar y clasificar las APIs de manera efectiva, optimizando la estructura y facilitando el acceso según el propósito o uso de cada API.

  • Edit

    La opción Edit en Categories permite modificar los detalles de una categoría existente en el catálogo.

    Al seleccionar esta opción, se despliega un formulario con la configuración actual de la categoría, donde los desarrolladores pueden ajustar el Name.

    D2

    Esta funcionalidad facilita la actualización de las categorías, asegurando que la organización de las APIs sea clara y se mantenga alineada con los cambios o necesidades de la plataforma.

  • Delete

    La opción Delete permite eliminar una categoría existente en el catálogo.

    Al seleccionar esta opción, se despliega un mensaje de confirmación para asegurar que se desea proceder con la eliminación.

    D2

    Una vez confirmada, la categoría será eliminada del sistema, lo cual ayuda a mantener el catálogo organizado y libre de categorías obsoletas o innecesarias.

Nota


Para acceder a esta interfaz, se debe seleccionar "Portal" desde el árbol de opciones y luego hacer clic en el botón "Details" sobre el portal elegido en la lista desplegada.

D2

Esto desplegará la interfaz correspondiente, donde se debe seleccionar el recuadro "Menu", como se muestra en la siguiente figura:

D2