En este artículo veremos cómo se usa Postman con nuestra API.
Postman es una plataforma para construir y usar API.
Postman se puede utilizar a través de su navegador web después de registrarse. La aplicación Postman se puede descargar aquí.
GET
Esta es la ventana que verá una vez que se haya registrado y abierto Postman.
- GET: aquí definirá qué tipo de operación desea realizar. En RecMan, usamos GET y POST, pero en este ejemplo usaremos GET.
- URL: si está realizando un GET, puede escribir una URL con alcance, tipo y campos aquí. Ver ejemplos en los artículos.
- Enviar: una vez que toda la información esté en su lugar, presione Enviar para realizar la operación seleccionada y obtener información de su base de datos.
-
Esta barra tiene algunas opciones, pero al realizar un GET, solo debe preocuparse por el botón Encabezados. La pestaña Encabezado debe contener la siguiente información:
- Aquí se muestra lo que devolvió su operación. En este ejemplo, la devolución fue Publicaciones de empleo y la salida está en JSON.
- Aquí puedes ver tus operaciones anteriores. Puede volver fácilmente a las operaciones anteriores y realizarlas de nuevo.
POST
Al realizar una POST, su pantalla se verá ligeramente diferente y usted define el alcance, el campo y la CLAVE en una ubicación diferente.
Nota
Tenga en cuenta que cualquier operación realizada con un POST hará cambios en su sistema. Potencialmente, puede eliminar información en su sistema RecMan.
- POST – Hemos definido que realizaremos un POST desde el menú.
- La URL al realizar un POST siempre es https://api.recman.no/post/.
Nota
Asegúrate de que la URL que usas al realizar una publicación es idéntica a esta. Un solo error de tipeo resultará en una operación fallida.
- ENVIAR: después de haber definido todo, presiona ENVIAR para ejecutar la operación.
- Mientras que el Encabezado debería tener el mismo aspecto que en GET, el campo importante aquí es el Cuerpo. Como se muestra en el ejemplo, su operación ahora está definida por un script en lugar de la URL, y aquí la sintaxis es importante. Consulte los ejemplos en los artículos POST.
- La salida. El único resultado que obtienes al realizar un POST es «success»: true o «success»: false, dependiendo del éxito de la operación.
- El registro de sus GET y POST anteriores.