API Settings

Las documentaciones disponibles en API DOCS pueden ser configuradas en API Settings.

En la página de API Settings, puede configurar la API para permitir que los desarrolladores hagan llamadas a la API directamente desde la documentación (tryout), habilitar el registro de aplicaciones y permitir que la API sea exhibida en el Catálogo.

API Settings

Esta configuración está disponible solo para APIs que fueron importadas automáticamente con la conexión.

Conozca más sobre:

API Settings

Para acceder a la pantalla API Settings, siga estos pasos:

  1. Acceda al API DOCS.

  2. Localice la API que desea probar.
    Si es necesario, utilice la herramienta de búsqueda.

  3. En la columna ACTIONS de la lista de APIs, haga clic en ícono de un lápiz de la API deseada.

    La columna AVAILABILITY indica si:

    • icono con una marca de verificación la API está disponible para la creación de aplicaciones y para ser mostrada en el catálogo;

    • icono amarillo con la letra i la API no está disponible para ser mostrada en el catálogo o (exclusivo) para la creación de aplicaciones.

    • icono rojo con la letra i la API no está disponible para ser mostrada en el catálogo y (conjunción) para la creación de aplicaciones.

Tryout

Este recurso permite que haga llamadas para la API, directamente desde la documentación.

Con el tryout, puede comprender cómo son los formatos de las solicitudes y respuestas y cuáles son los parámetros requeridos por cada endpoint.

Siga estos pasos para utilizar el tryout:

  1. Siga los pasos anteriores para llegar a la pantalla API Settings.

  2. En la página siguiente, en API Settings, haga clic en SELECT TRYOUT ENVIRONMENT.
    botón para seleccionar el entorno

  3. En la pantalla que se abrirá, elija el entorno de la API que desea probar. entornos disponibles

  4. Navegue por la documentación de la API y haga clic en Tryout para hacer llamadas a los endpoints.

    botão para testar o endpoint

    Si es necesario, haga clic en Authorize e ingrese las credenciales para acceder a la API.
    botón authorize

  5. Los resultados se muestran debajo del endpoint. Vea un ejemplo a continuación.

ejemplo de resultados de una llamada de prueba

Permitir el registro de APPs

Para permitir que los desarrolladores registren sus aplicaciones en el Developer Portal, seleccione la opción Enable Registration.

Si esta opción está deshabilitada, los desarrolladores no podrán registrar sus aplicaciones en el Developer Portal.

ubicación del toggle para habilitar el registro de APPs

Esta opción solo está disponible para API de conexiones nativas.

Permitir la visualización de la API en el Catálogo

Para permitir que la API sea exhibida en el Catálogo, seleccione la opción Enable in Portal Catalog.

Si prefiere que la API no se muestre en el catálogo, deje el botón Enable in Portal Catalog deshabilitado.

ubicación del toggle para habilitar la visualización de la API en el Catálogo

Thanks for your feedback!
EDIT

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