Introduction

The datasets service main goal is to provide geographic operations on large datasets.

Authentication product

The Datasets API requires the DATASETS product to be activated on the target project.

Goals

• Importing big geographic datasets (shapefiles)
• Fast geographic querying API
• Fast attributes querying API

Playground supports the following parameters:

• datasetId: the dataset id you want to play with
• privateKey: the private key bound the same project as the dataset
• host: the base Url for api calls defaults to https://develop-api.woosmap.com

General Idea

To support big files import we borrow an idea implemented in Portal known as reimport_url.

The idea behind reimport_url is that instead of the user pushing the data to the service, the service knows the URL of the file and fetches it (see Import).

This implementation goes one step further by running the import in a worker behind a redis queue.

Main features

• Allows async import triggering
• search and geographic operations (intersects, within, contains, nearby)

Built with

This service is developed using FastApi the postgres integration is done with SQLAlchemy migrations are handled by Alembic.

Geometry manipulation is done through GDAL.

Openapi

The openapi specification lives under /datasets/docs path (Develop docs, Production docs).

Specific topics documentation:

• database models
• rate limits