Antes de acceder a la API con un explorador
Sugerir cambios
PDF
Hay varias cosas que debe tener en cuenta antes de utilizar la página de documentación en línea de implementación.
Plan de implementación
Si piensa emitir llamadas API como parte de la realización de tareas administrativas o de implementación específicas, debería considerar la creación de un plan de implementación. Estos planes pueden ser formales o informales, y, por lo general, contienen sus objetivos y las llamadas a las API que se deben utilizar. Consulte procesos de flujo de trabajo mediante la API DE REST de puesta en marcha para obtener más información.
Ejemplos de JSON y definiciones de parámetros
Cada llamada API se describe en la página de documentación usando un formato consistente. El contenido incluye notas de implementación, parámetros de consulta y códigos de estado HTTP. Además, puede mostrar detalles sobre JSON utilizado con las solicitudes y respuestas de API de la siguiente manera:
-
Valor de ejemplo
Si hace clic en example value en una llamada a la API, se muestra una estructura JSON típica para la llamada. Puede modificar el ejemplo según sea necesario y utilizarlo como entrada para su solicitud. -
Modelo
Si hace clic en Model, se muestra una lista completa de los parámetros JSON, con una descripción para cada parámetro.
Precaución al emitir llamadas API
Todas las operaciones de API que se realizan mediante la página de documentación de implementación son operaciones en directo. Debe tener cuidado de no crear, actualizar o eliminar por error la configuración u otros datos.