General Info

En la pestaña General Info puede:

General Info

Accediendo a la pestaña General Info

Siga estos pasos para acceder a la pestaña General Info:

  1. Acceda a la página API Catalog, haciendo clic en el menú lateral izquierdo o en la tarjeta correspondiente en la pantalla inicial del Developer Portal.

    acceso al API Catalog

  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.

Configurando credenciales

Para ingresar con credenciales de acceso para la API:

  1. Acceda a la pestaña General Info en API Catalog.

  2. Haga clic en AUTHORIZE (en verde).

    authorize

  3. Ingrese el valor de la clave en el campo Value, como se muestra en la imagen a continuación.

modal de autorizaciones disponibles

Tryout

Este recurso le permite realizar llamadas a 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.

Consulte cómo elegir el ambiente para tryout.

Siga estos pasos para utilizar el tryout:

  1. Siga los pasos para llegar a la pestaña Settings and Permissions.

  2. En Settings and Permissions, haga clic en SELECT TRYOUT ENVIRONMENT.
    botón para seleccionar ambiente

  3. En la pantalla que se abra, elija el ambiente de la API que desea probar.
    ambientes disponibles

    Los ambientes disponibles para tryout se nombran de manera estandarizada, independientemente del proveedor, según las especificaciones técnicas del contrato de la API:

    • Para OpenAPI 3.x: la información se obtiene de los campos servers.url (dirección) y servers.description (nombre del entorno).

    • Para Swagger 2.0: la URL se forma combinando los campos scheme, host y basePath.

    Si el contrato no proporciona una descripción explícita para el entorno, el sistema utiliza el host de la URL como identificador o busca automáticamente palabras clave (como prod, dev o test) para nombrar el entorno.

  4. Navegue por la documentación de la API y haga clic en Try it out para realizar llamadas a los endpoints.

    botón para probar el endpoint

    Si es necesario, haga clic en Authorize e inserte las credenciales para acceder a la API.

  5. Los resultados se mostrarán justo debajo del endpoint. Vea un ejemplo a continuación.

ejemplo de resultado de la llamada
Thanks for your feedback!
EDIT

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