Puede probar cualquier API disponible en su organización directamente desde la página Explorador de API de Consola de Cloud Services.

Requisitos previos

Debe tener la función Propietario de la organización en la organización.

Procedimiento

  1. Inicie sesión en su organización en Consola de Cloud Services.
  2. Desplácese hasta Centro de desarrolladores > Explorador de API.
  3. En el menú API disponibles de la página Explorador de API, seleccione una categoría de API.
    La página se actualiza para mostrar todas las API disponibles en la categoría seleccionada.
  4. Utilice el icono de flecha para expandir el contenido de una API.
  5. Desplácese hacia abajo hasta la sección Pruébelo.
    Ejemplo de la sección Pruébelo de una API.
  6. Para crear una llamada API, rellene las propiedades requeridas.
    Siempre que es posible, se rellenan previamente las propiedades en función de los detalles del entorno que se muestran en el lado derecho de la página.
    Al compilar o utilizar integraciones de API o llamadas al servidor de forma local, puede usar fragmentos de las muestras de las especificaciones de API. Una forma sencilla de conseguirlo es hacer clic en el botón Descargar las especificaciones Open API/Swagger situado en las partes superior e inferior de la página Explorador de API. El archivo de especificaciones contiene llamadas de muestra y respuestas esperadas.
  7. Haga clic en Ejecutar.
    Nota: Todas las llamadas API que realice desde Explorador de API se ejecutarán en el entorno activo. Utilice la funcionalidad Pruébelo con precaución.

Resultados

Cuando se ejecuta la llamada API, la página se actualiza para mostrar la respuesta justo debajo de la sección Pruébelo de la página Explorador de API. Puede interactuar con la respuesta del modelo, ver la carga útil en formato de texto y copiar o descargar la respuesta.

Ejemplo:

En este ejemplo, se utiliza una API de la categoría Gestión de identidad y acceso para obtener información sobre Usuario principal (el usuario que tiene una sesión iniciada actualmente en la organización).

  1. Abra Explorador de API.
  2. En la lista API disponibles, seleccione Gestión de identidad y acceso.
  3. En la lista Categorías de API que se muestra, haga clic en Usuario principal.
  4. Haga clic en GET /am/api/loggedin/user.
  5. Haga clic en Ejecutar.

La respuesta a la llamada API creada se muestra en la sección Respuesta de la página y devuelve la información de usuario con la que se inició sesión en la organización.