A menudo utilizo Postman para consultar la API de Open-AudIT cuando estoy desarrollando. Sólo con un navegador, es difícil enviar algo más que una solicitud GET, pero Postman hace que sea sencillo enviar un POST, PATCH o DELETE según sea necesario. Puede obtenerlo en https://www.getpostman.com/downloads/ para Windows, Mac y Linux.
Instala e inicia Postman. Puedes elegir crear una cuenta o no. También puedes elegir crear un nuevo elemento utilizando el asistente, o simplemente cerrar el modal y entrar. Hagámoslo.
En este caso, mi servidor Open-AudIT se ejecuta en 192.168.84.4. Debe sustituir la dirección IP de su servidor de Open-AudIT.
Primero, necesitas hacer un post a /login para obtener una cookie. Poner el desplegable en POST y la URL en http://192.168.84.4/omk/open-audit/login. Establece la cabecera Accept a application/json. Establezca el cuerpo como form-data y proporcione las claves de nombre de usuario y contraseña, con los valores apropiados para su instalación. Por defecto, el aspecto será el siguiente. Ahora haga clic en el botón Enviar.
Debería ver el resultado JSON diciendo que se ha autenticado.
Una vez hecho esto, es el momento de solicitar algunos datos. Haz una petición GET a http://192.168.84.4/omk/open-audit/devices y deberías obtener una respuesta JSON con una lista de dispositivos. Puedes ver el inicio del JSON en la captura de pantalla de abajo.
¿Qué hay de cambiar el atributo de un artículo? No es demasiado difícil. Necesitará el ID del dispositivo que desea cambiar, junto con el nombre del atributo de la base de datos. Puede verlos en la aplicación yendo al menú → Admin → Base de datos → Tablas de lista y haciendo clic en la tabla "sistema". Vamos a cambiar la descripción de nuestro dispositivo con ID 14.
Para ello tendrás que crear un objeto JSON y asignarlo al elemento "data". No es demasiado difícil. Tu objeto JSON debería tener el siguiente aspecto (formateado y con sangría para facilitar la lectura).
{
"data": {
"id": "14",
"type": "devices",
"attributes": {
"description": "My New Description"
}
}
}
Parece peor de lo que es. Normalmente se usaría código para hacer esto, así que es una simple conversión de dos líneas. Como estamos usando Postman, tendremos que hacerlo nosotros mismos. Un sitio útil es https://jsonlint.com/
Ahora que tiene su carga útil, envíela a Open-AudIT. Haz una nueva petición PATCH y utiliza la URL http://192.168.84.4/omk/open-audit/devices/14.
Suministre el atributo data en la sección body → x-www-form-urlencoded y pulse Enviar. Debería ver la solicitud como la siguiente.
Borrar un elemento es aún más fácil. Vamos a borrar una Org. En este caso, nuestra Org con ID 2. Haz una nueva solicitud DELETE a http://192.168.84.4/omk/open-audit/orgs/2. Eso es todo - facil! /span>
Y si queremos leer una entrada específica, es sólo una solicitud GET. Obtengamos nuestra Org por defecto - ID 1. Sólo hay que hacer un GET a http://192.168.84.4/omk/open-audit/orgs/1.
¿Qué pasa con la ejecución de una consulta? ¿Cuál es el verbo HTTP utilizado para EJECUTAR algo? No hay ninguno. Pero nos conformaremos con suministrar /execute después del ID. Así que para ejecutar una consulta, haz una petición GET a http://192.168.84.4/omk/open-audit/queries/1/execute. Para ejecutar un descubrimiento, una tarea o una línea de base, utilice el mismo formato: ID/ejecución.
Recuerde que siempre recibimos el resultado en JSON, ya que está en nuestra cabecera de solicitud. Podríamos recibirlo como HTML si así lo deseamos - sólo hay que eliminar ese elemento de la cabecera. Tal vez sea más útil una salida CSV. Elimina la cabecera Accept y cambia la URL para un GET a http://192.168.84.4/omk/open-audit/queries/1/execute?format=csv. Hecho - salida CSV que puede copiar y pegar en Excel.
Realmente es así de sencillo. La única que hay que vigilar es la petición PATCH porque hay que crear su propio JSON. Casi todo lo demás es bastante fácil de descubrir. Asegúrese de consultar las páginas de Colecciones que detallan los formatos de solicitud. Y no olvides la página la API de Open-AudIT página también.
Hacia delante y hacia arriba.
Mark Unwin.
