[API] Crear un primer endpoint con autenticación básica

[viktorKhan]

https://book.cakephp.org/2/en/development/rest.html

https://medium.com/@abeltolu/build-a-rest-api-using-cakephp-2-x-in-3-minutes-1abe842ad7a1 https://medium.com/@jeremy_burns/restful-api-with-cakephp-2-9-91852c0a60ee

[viktorKhan]

Ejemplo de URL de búsqueda de citas:

http://local.anuario.albacete.org/cita/?especie=Calandria+com%C3%BAn%2C+Melanocorypha+calandra&especieId=436&figuraProteccion=&claseReproduccionId=&estudioId=&comarcaId=&municipioId=&cuadriculaUtmId=&lugar=&lugarId=&fechaDesde=01%2F01%2F2020&fechaHasta=&observador=&observadorId=&colaborador=&colaboradorId=

[viktorKhan]

Se ha creado una página de documentación sobre la nueva API en la plataforma swagger.io

https://app.swaggerhub.com/apis/sao-albacete/aoa/1.0.0

[viktorKhan]

Actualmente está documentada la primera llamada a la API en la que estamos trabajando que es la búsqueda de citas. Este endpoint no necesita autenticación, al igual que ocurre con la aplicación. Queda pendiente implementar:

• la paginación
• filtros de búsqueda

[viktorKhan]

Toda la información de la API está en inglés, ya que el objetivo de la API es que desde cualquier parte del mundo puedan acceder a los datos del anuario.

[viktorKhan]

Este es un ejemplo de la respuesta que enviaremos al llamar a

GET http://anuario.albacete.org/observations.json

{
    "observations": [
        {
            "observation-date": "2020-04-14 07:30:00",
            "amount": {
                "total": "1",
                "detail": [
                    {
                        "gender-and-age": "Adulto macho",
                        "total": "1"
                    }
                ]
            },
            "species": {
                "code": "AAR",
                "euring-code": "12530",
                "aerc-code": "711",
                "common-name": "Carricero tordal",
                "english-name": "Great Reed Warbler",
                "scientific-name": "Acrocephalus arundinaceus"
            },
            "location": {
                "name": "Alcozarejos",
                "x-axis": null,
                "y-axis": null,
                "utm-10x10-cell": "XJ2030",
                "municipality": "Jorquera",
                "region": "La Manchuela"
            },
            "watcher": {
                "name": "Víctor Cañizares Mata",
                "code": "VC",
                "collaborators": []
            },
            "source": "Observaciones propias",
            "study": {
                "name": "Citas",
                "description": "Citas de observaciones, no forman parte de ningún estudio."
            },
            "in-rare-habitat": false,
            "breeding-in-weird-habitat": false,
            "injured": false,
            "rare-behaviour-or-morphology": false,
            "hasPhoto": true,
            "notes": ""
        },
        {
            "observation-date": "2020-04-13 12:30:00",
            "amount": {
                "total": "1",
                "detail": [
                    {
                        "gender-and-age": "Adulto macho",
                        "total": "1"
                    }
                ]
            },
            "species": {
                "code": "ARA",
                "euring-code": "1080",
                "aerc-code": "173",
                "common-name": "Garcilla cangrejera",
                "english-name": "Squacco Heron",
                "scientific-name": "Ardeola ralloides"
            },
            "location": {
                "name": "Laguna de Ontalafia",
                "x-axis": null,
                "y-axis": null,
                "utm-10x10-cell": "XH0080",
                "municipality": "Albacete",
                "region": "Llanos de Albacete"
            },
            "watcher": {
                "name": "Víctor Cañizares Mata",
                "code": "VC",
                "collaborators": []
            },
            "source": "Observaciones propias",
            "study": {
                "name": "Citas",
                "description": "Citas de observaciones, no forman parte de ningún estudio."
            },
            "in-rare-habitat": false,
            "breeding-in-weird-habitat": false,
            "injured": false,
            "rare-behaviour-or-morphology": false,
            "hasPhoto": false,
            "notes": ""
        },
}