Services¶
wis2box provides a number of data access services and mechanisms in providing data to users, applications and beyond.
Discovery Catalogue¶
The discovery catalogue is powered by OGC API - Records and is located at http://localhost:8999/oapi/collections/discovery-metadata
The OGC API endpoint is located by default at http://localhost:8999/oapi. The discovery catalogue endpoint is located at http://localhost:8999/oapi/collections/discovery-metadata
Below are some examples of working with the discovery catalogue.
description of catalogue: http://localhost:8999/oapi/collections/discovery-metadata
catalogue queryables: http://localhost:8999/oapi/collections/discovery-metadata/queryables
catalogue queries
records (browse): http://localhost:8999/oapi/collections/discovery-metadata/items
query by spatial (bounding box): http://localhost:8999/oapi/collections/discovery-metadata/items?bbox=32,-17,36,-8
query by temporal extent (since): http://localhost:8999/oapi/collections/discovery-metadata/items?datetime=2021/..
query by temporal extent (before): http://localhost:8999/oapi/collections/discovery-metadata/items?datetime=../2022
query by freetext: http://localhost:8999/oapi/collections/discovery-metadata/items?q=observations
Note
adding
f=json
to URLs will provide the equivalent JSON/GeoJSON representationsquery predicates (
datetime
,bbox
,q
, etc.) can be combined
See also
Data API¶
wis2box data is made available via OGC API - Features and is located at http://localhost:8999/oapi standards.
The OGC API endpoint is located by default at http://localhost:8999/oapi
Below are some examples of working with the discovery catalogue.
Note
the examples below use the
mwi.mwi_met_centre.data.core.weather.surface-based-observations.SYNOP
collection as described in the Quickstart. For other dataset collections, use the same query patterns below, substituting the collection id accordingly
list of dataset collections: http://localhost:8999/oapi/collections
collection description: http://localhost:8999/oapi/collections/mwi.mwi_met_centre.data.core.weather.surface-based-observations.SYNOP
collection queryables: http://localhost:8999/oapi/collections/mwi.mwi_met_centre.data.core.weather.surface-based-observations.SYNOP/queryables
collection items (browse): http://localhost:8999/oapi/collections/mwi.mwi_met_centre.data.core.weather.surface-based-observations.SYNOP/items
collection queries
set limit/offset (paging): http://localhost:8999/oapi/collections/mwi.mwi_met_centre.data.core.weather.surface-based-observations.SYNOP/items?limit=1&startindex=2
query by spatial (bounding box): http://localhost:8999/oapi/collections/mwi.mwi_met_centre.data.core.weather.surface-based-observations.SYNOP/items?bbox=32,-17,36,-8
query by temporal extent (since): http://localhost:8999/oapi/collections/mwi.mwi_met_centre.data.core.weather.surface-based-observations.SYNOP/items?datetime=2021/..
query by temporal extent (before): http://localhost:8999/oapi/collections/mwi.mwi_met_centre.data.core.weather.surface-based-observations.SYNOP/items?datetime=../2022
Note
adding
f=json
to URLs will provide the equivalent JSON/GeoJSON representationsquery predicates (
datetime
,bbox
,q
, etc.) can be combined
See also
Management API¶
The Data API also provides a management API to manage resources in alignment with OGC API - Features - Part 4: Create, Replace, Update and Delete.
SpatioTemporal Asset Catalog (STAC)¶
The wis2box SpatioTemporal Asset Catalog (STAC) endpoint can be found at:
…providing the user with a crawlable catalogue of all data on a wis2box.
Web Accessible Folder (WAF)¶
The wis2box Web Accessible Folder publich bucket endpoint can be found at:
…providing the user with a crawlable online folder of all data on a wis2box.
Broker¶
The wis2box broker is powered by MQTT and can be found at:
mqtt://localhost:1883
…providing a PubSub capability for event driven subscription and access.
Adding services¶
wis2box’s architecture allows for additional services as required by adding Docker containers. Examples of additional services include adding a container for a samba share or FTP server. Key considerations for adding services:
Storage buckets can be found at http://minio:9000
Elasticsearch indexes can be found at the container/URL
http://elasticsearch:9200
Examples of additional services can be found in docker/extras
.