Llega una actualización que debería haber sido desarrollada hace mucho tiempo, pero la disponibilidad no juega de nuestro lado. Para compensar la espera, se ha integrado con una famosa interfaz (Swagger) que permitirá interactuar con facilidad sin necesidad de hacer ningún script ni peticiones en Postman o similares:
https://www.fp-informatica.es/api/documentation
Nada más abrir la dirección, veréis la lista de endpoints disponibles en esta primera versión. Entre otras cosas podemos obtener la lista de últimos centros agregados al sistema, obtener alertas del usuario y eliminarlas.
Todo lo relacionado con las alertas se explicará en otro tema para no desvirtuar este.
Primeros pasos con la API
Por ahora no hay demasiadas funcionalidades, pero se irán incrementando con el tiempo. Antes de nada veremos que hay dos tipos de solicitudes: las que incluyen un candado a la derecha y las que no.
En el primer caso, indica que necesitamos una cuenta de usuario de la comunidad. Así que si aún no la has creado, ya sabes. 😜
En el segundo caso pueden realizarse peticiones sin necesidad de identificarse.
Autenticación
Esta petición es esencial para poder usar todo el sistema. Vamos a generar un token (X-API-Key) que ayude a verificar quienes somos y para ello vamos a lanzar una petición sobre generateKey enviando nuestro usuario y contraseña.
A la derecha podemos ver un botón "Try it out" que nos desbloqueará el formulario con los parámetros requeridos y un botón de ejecución.
Si todo ha ido bien devolverá un token válido por una semana, cuando caduca simplemente debemos volver a mandar otra petición para generar uno nuevo.
Importante almacenarlo en algún lugar seguro ya que sin éste, no podremos trabajar con el resto de funcionalidades.
Puede ocurrir que lo pierdas, no habrá problema. Vuelve a mandar una petición y le desactivarán todos los que hubiese activos en ese momento.
¿Cómo saber si aún sigue vigente? Lo descubrirás si lo introduces en cualquiera de los endpoints protegidos y te devuelve el código de error 401, aclarando que la autenticación no es válida.
Ejemplo de petición que solicita el token
Y como respuesta, en caso satisfactorio, obtendremos un JSON con los datos solicitados.
Si tienes alguna duda sobre la API, este es tu lugar para comentarla.
Un saludo.
