Settings and Permissions (configuraciones y permisos)

En la pestaña Settings and Permissions, puede:

  • Habilitar el registro de Apps y permitir que la API se muestre en el Catálogo.

  • Configurar la API para permitir que los desarrolladores realicen llamadas directamente desde la documentación (tryout).

  • Definir los roles para el control de accesos.

  • Elegir el ambiente para tryout.

pestaña Settings and Permissions

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

Vea cómo:

Accediendo a la pestaña Settings and Permissions

Siga estos pasos para acceder a la pestaña Settings and Permissions:

  1. Acceda a la página API DOCS, haciendo clic en el menú lateral izquierdo o en la tarjeta en la pantalla inicial del Developer Portal.
    pantalla inicial con énfasis en 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 el ícono de un lápiz de la API deseada.

    La columna AVAILABILITY indica si:

    • ícono con una marca de verificación La API está disponible para mostrarse en el catálogo y para la creación de apps.

    • ícono amarillo con la letra i La API no está disponible para mostrarse en el catálogo o (o exclusivo) para la creación de apps.

    • ícono rojo con la letra i La API no está disponible para mostrarse en el catálogo y (conjunción) para la creación de apps.

Permitir el registro de Apps

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

Mantenga el botón Enable Apps Registration deshabilitado si desea bloquear el registro de Apps.

ubicación del alternador para habilitar el registro de Apps

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

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

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

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

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

Roles

Puede definir uno o más roles que pueden tener acceso a la documentación de la API listada en API Docs.

Siga estos pasos para editar los permisos de roles:

  1. Acceda a la página API Docs, haciendo clic en el menú lateral izquierdo o en la tarjeta en la página inicial.
    pantalla inicial con énfasis en api docs

  2. Encuentre la API deseada y haga clic en el ícono ícono de un lápiz, en la columna ACTIONS.

  3. Haga clic en la pestaña SETTTINGS & PERMISSIONS.

  4. En el campo ROLES, seleccione uno o más roles.
    Para ver la documentación de la API, será necesario que el usuario tenga uno de estos roles.
    Un usuario que tenga un rol que no está listado aquí no podrá acceder a la API.

pantalla de actualización de api docs con énfasis en la pestaña settings and permissions y en el campo roles

Seleccionar ambiente para tryout

Con el tryout, puede realizar llamadas a la API directamente desde la documentación. Consulte cómo utilizar el tryout.

Para definir el ambiente para el tryout:

  1. Acceda a la página API Docs, haciendo clic en el menú lateral izquierdo o en la tarjeta en la página inicial.
    pantalla inicial con énfasis en api docs

  2. Encuentre la API deseada y haga clic en el ícono ícono de un lápiz, en la columna ACTIONS.

  3. Haga clic en la pestaña SETTTINGS & PERMISSIONS.

  4. Haga clic en el botón SELECT TRYOUT ENVIRONMENTS.

  5. Seleccione uno o más ambientes.

  6. Si lo desea, puede definir un ambiente predeterminado. Simplemente seleccione la opción en la columna DEFAULT.

Thanks for your feedback!
EDIT

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