Skip to main content
Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

Emitir solicitudes API

Colaboradores
PDF

La interfaz de usuario de Swagger proporciona detalles y documentación completos para cada operación de API.

Lo que necesitará

  • Debe iniciar sesión en Grid Manager mediante un explorador compatible.

  • Debe tener permisos de acceso específicos.

Importante Cualquier operación de API que realice mediante la página web de documentos de API es una operación en directo. Tenga cuidado de no crear, actualizar o eliminar datos de configuración u otros datos por error.
Pasos

  1. Seleccione Ayuda > Documentación de API en el encabezado de Grid Manager.

  2. Seleccione la operación deseada.

    Al expandir una operación de API, puede ver las acciones HTTP disponibles, como GET, PUT, UPDATE y DELETE.

  3. Seleccione una acción HTTP para ver los detalles de la solicitud, incluida la dirección URL del extremo, una lista de los parámetros necesarios o opcionales, un ejemplo del cuerpo de la solicitud (cuando sea necesario) y las posibles respuestas.

    Ejemplo de interfaz de usuario de Swagger

  4. Determine si la solicitud requiere parámetros adicionales, como un ID de grupo o de usuario. A continuación, obtenga estos valores. Es posible que primero deba emitir una solicitud de API diferente para obtener la información que necesita.

  5. Determine si necesita modificar el cuerpo de solicitud de ejemplo. Si es así, puede hacer clic en Modelo para conocer los requisitos de cada campo.

  6. Haga clic en probar.

  7. Proporcione los parámetros necesarios o modifique el cuerpo de la solicitud según sea necesario.

  8. Haga clic en Ejecutar.

  9. Revise el código de respuesta para determinar si la solicitud se ha realizado correctamente.