API metadades

Documentació API Metadades

Taules

Per a cada tipus d’element s’ha creat una taula per guardar informació de les metadades

Taula element	Taula metadades
giscube_dataset	giscube_datasetmetadata
imageserver_service	imageserver_servicemetadata
layerserver_geojsonlayer	layerserver_geojsonlayermetadata
layerserver_databaselayer	layerserver_databaselayermetadata
qgisserver_service	qgisserver_servicemetadata

URL API


Endpoint	api/v2/giscube/search/
Exemple	https://xxxxxxx.xxxxxxx.xxx/apps/giscube-admin/api/v2/giscube/search/

Autentificació

Per accedir a aquesta API cal autentificació. O sigui, s’ha d’enviar un token al servidor.

Aquest es pot enviar de dues maneres:

Paràmetre access_token en una petició GET


Paràmetre	access_token
Exemple	https://xxxxxxx.xxxxxxx.xxx/giscube-admin/api/v2/giscube/search/?access_token=JIFbeOLxkW87wvu3a5at9164IGv7w7

Capçalera HTTP


Paràmetre	Authorization
Exemple	Authorization=Bearer JIFbeOLxkW87wvu3a5at9164IGv7w7

Generar Token

Exemple de crida per generar un token

CLIENT_ID=b84uwJOlbtjeTAtThoazZFssE4RimQh3kyEiA8Z2

USERNAME=exemple

PASSWORD=exemple

curl -X POST -d "client_id=$CLIENT_ID&grant_type=password&username=$USERNAME&password=$PASSWORD" \

  https://xxxxxxx.xxxxxxx.xxx/apps/giscube-admin/o/token/

Paràmetres de l’API

Cerca per text
Paràmetre	q
Descripció	Cerca per coincidencia de text en els camps’name’, ‘title’, ‘keywords’, ‘metadata.provider_name’, ‘category.title’, ‘description’
Exemple	q=escoles

Cerca per data
Paràmetre	d
Descripció	Cerca per metadata.data. Cerca per any o rang de dates (separades per coma) Format: yyyy
Exemple	https://xxxxxxx.xxxxxxx.xxx/apps/giscube-admin/api/v2/giscube/search/?d=2010,2020 https://xxxxxxx.xxxxxxx.xxx/apps/giscube-admin/api/v2/giscube/search/?d=2020
Observacions	Cerca per un any en concret o per un període d’anys

Cerca per tipus element
Paràmetre	e
Descripció	Cerca per tipus d’element: giscube.dataset, imageserver.service, qgisserver.service, layerserver.geojsonlayer, layerserver.databaselayer
Exemple	https://xxxxxxx.xxxxxxx.xxx/apps/giscube-admin/api/v2/giscube/search/?e=giscube.dataset

Cerca per distància
Descripció	Cerca els elements que per distancia interseccionin per distància a un punt
Paràmetre	p
Descripció paràmetre	Parella de decimals, coordenada, que correspon a la longitud i la latitud, separada per una coma.Els decimals cal que estiguin en format anglès
Paràmetre	r
Descripció paràmetre	Radi en metresPer defecte 25 metres. Opcional.
Paràmetre	epsg
Descripció paràmetre	Indica el sistema de coordenades de la geometriaExemple: epsg=25831Opcional. Per defecte 4326.
Exemple	https://xxxxxxx.xxxxxxx.xxx/apps/giscube-admin/api/v2/giscube/search/?p=1.111068,41.144431

Intersecció a una geometria
Descripció	Cerca els elements que el bbox interseccionin amb la geometria
Paràmetre	intersects
Descripció paràmetre	Geometria en format wkt
Paràmetre	epsg
Descripció paràmetre	Indica el sistema de coordenades de la geometriaExemple: epsg=25831Opcional. Per defecte 4326
Exemple	https://xxxxxxx.xxxxxxx.xxx/apps/giscube-admin/api/v2/giscube/search/?intersects=LINESTRING(1.0968840476263697%2041.15210198069979,1.1035788413275416%2041.14919367735578,1.1106169577826197%2041.15126181742966)

Dins els límits d’una geometria
Descripció	Cerca els elements que estan completament dins una geometria especificada.
Paràmetre	contains
Descripció paràmetre	Geometria en format wkt
Paràmetre	epsg
Descripció paràmetre	Indica el sistema de coordenades de la geometriaExemple: epsg=25831Opcional. Per defecte 4326
Exemple	https://xxxxxxx.xxxxxxx.xxx/apps/giscube-admin/api/v2/giscube/search/?contains=POLYGON((-1.6796875000000178%2045.320172290013765,6.582031249999982%2045.320172290013765,6.582031249999982%2037.8389415037292,-1.6796875000000178%2037.8389415037292,-1.6796875000000178%2045.320172290013765))