Prueba de una API utilizando la herramienta de prueba Portal del desarrollador

Puede probar el comportamiento de una API sin necesidad de escribir ningún código utilizando la herramienta de prueba Portal del desarrollador . Proporcione los parámetros de API necesarios en la herramienta de prueba y pulse Invocar para ver la respuesta.

Antes de empezar

Para utilizar la herramienta de prueba Portal del desarrollador con una API que requiere un ID de cliente de aplicación, primero debe completar las tareas siguientes:

Acerca de esta tarea

La herramienta de prueba Portal del desarrollador es una herramienta de prueba de documentos de API interactiva. Si la operación que desea probar no requiere un ID de cliente, puede utilizar la herramienta de prueba Portal del desarrollador sin necesidad de iniciar la sesión. Sin embargo, si la operación con la que desea interactuar requiere un ID de cliente, primero debe iniciar sesión en el Portal del desarrollador .

El uso de la herramienta de prueba Portal del desarrollador está sujeto al límite de velocidad que se aplica a una operación o plan. Por ejemplo, si una operación tiene un límite de velocidad de 10 solicitudes por minuto e invoca la operación, el número de solicitudes que se pueden realizar se reduce a nueve. Las limitaciones se desencadenan cada vez que pulsa invocar dentro del intervalo de minutos. Esta advertencia afecta a la cuota de la aplicación que se ha seleccionado para utilizar con la herramienta de prueba Portal del desarrollador , pero no afecta a la cuota de las otras aplicaciones que utilizan la misma operación o plan.

Para probar una API en el Portal del desarrollador, el recuadro de selección Permitir que se pruebe esta API debe estar seleccionado en el Gestor de API. Para obtener más información, consulte Creación de definiciones de API.

Restricción:
  • Existen mecanismos de seguridad que impiden utilizar la herramienta de prueba Portal del desarrollador para probar un tipo de otorgamiento Implícito o Código de autorización en una API de proveedor OAuth. Otros tipos de otorgamiento en la misma API de proveedor OAuth se pueden probar. Si el proveedor de OAuth permite que estas acciones funcionen correctamente desde la herramienta de prueba, puede inhabilitar esta opción. Para obtener más información, consulte Inhabilitación de restricciones de la herramienta de prueba.
  • No puede utilizar la herramienta de prueba Portal del desarrollador con aplicaciones suspendidas.
  • Sólo puede probar una API no impuesta si testable=true, y si la API existente implementa CORS y está utilizando HTTPS.
Nota: Las API de GraphQL se pueden probar desde la interfaz de usuario del Portal del desarrollador . Sin embargo, no se da soporte a todos los métodos de autenticación. Debe utilizar uno de los métodos de autenticación siguientes:
  • No protegido
  • ID de cliente, pasado en la cabecera
  • ID y secreto de cliente, pasados en la cabecera
Además, las métricas de cost no están soportadas y los límites de velocidad específicos de GraphQL no se listan en los planes de producto.

Procedimiento

  1. Para utilizar la herramienta de prueba Portal del desarrollador con una API que no requiere el ID de cliente de una aplicación, realice los pasos siguientes:
    1. Pulse Productos de API.
      Se muestran todas las API que pueden utilizar los desarrolladores de aplicaciones.
    2. Pulse el nombre de la API que desee probar.
    3. Seleccione una operación y, a continuación, seleccione Pruébelo.
    4. Pulse Probar esta operación.
    5. Proporcione los valores para las cabeceras o parámetros necesarios.
    6. Si la operación está protegido con una autenticación básica, proporcione las credenciales.
    7. Pulse Enviar solicitud.
      El resultado se muestra en el campo Cuerpo de respuesta . Puede seguir probando diferentes valores de parámetro según sea necesario.
      Nota:

      La primera vez que pulse Pruébelo, es posible que se le presente un error de seguridad. Copie el URL del campo URL de solicitud, ábralo en una ventana de navegador y acepte el certificado de seguridad. No se le volverá a presentar el error de seguridad.

      Además, por razones de rendimiento, si la carga útil es grande, más de 1500 elementos resaltados de DOM, obtendrá la respuesta, pero no está bastante impresa.

  2. Para utilizar la herramienta de prueba Portal del desarrollador con una API que requiere el ID de cliente de una aplicación, realice los pasos siguientes:
    1. Inicie sesión en el Portal del desarrollador.
    2. Si todavía no lo ha hecho, debe crear una app para poder probar una API que requiera un ID de cliente. Para obtener más información, consulte Registro de una aplicación.
    3. Asegúrese de que la aplicación está suscrita al plan que contiene la API que desea probar. Para obtener más información, consulte Exploración de API y productos en el Portal del desarrollador.
    4. Pulse Productos de API.
      Se muestran todas las API que pueden utilizar los desarrolladores de aplicaciones.
    5. Pulse la API que desea probar.
    6. Seleccione la operación Provide credentials for Client ID (API Key) y, a continuación, seleccione Pruébelo.
      Se visualiza la ventana Identificación de clave de API .
    7. Utilice la lista desplegable Registrar una aplicación para seleccionar un ID de cliente para seleccionar una aplicación con la que probar la API.
    8. Pulse Guardar credenciales.
    9. Si es necesario un secreto de cliente, especifique el valor en el campo Secreto de cliente .
    10. Busque la operación que desea probar y, a continuación, pulse Pruébelo.
    11. Proporcione los parámetros y valores necesarios.
    12. Si la operación está protegido con una autenticación básica, proporcione las credenciales.
    13. Pulse Enviar.
      El resultado se muestra en la sección Respuesta. Puede continuar probando diferentes valores de campo según sea necesario.
      Nota: La primera vez que pulse Invocar, es posible que se le presente un error de seguridad. Pulse el enlace que se proporciona para aceptar el certificado de seguridad. No se le volverá a presentar el error de seguridad.