API Template usage cheatsheet

Core principles

The Tygron Platform allows for Projects to be used as Templates. Applying them to a new location, carrying over their calculation models and configurations, means its possible to rapidly apply identical analyses. Using the API, this process can be fully automated.

Authentication

Every API call must be accompanied with an appropriate form of authentication

URL starts with	Description	Example
/api/	HTTP Basic Authentication Header	"Authorization: Basic "+b64en("user@example.com:password")
/api/session/	API token query parameter	"/api/session/items/neighborhoods?f=JSON&token=[...]"
/web/	Web (or API) token query parameter	"/api/web/2dmap.html?f=JSON&token=[...]"

Applying a Template project

Use "demo heat stress" to create a new Project named "my_project", and get its API Token:

	URL	Parameters	Response
POST	/api/io/start/	["EDITOR", "demo_heat_stress"]	sessionId
POST	/api/io/save_project_as/	[sessionId, "","my_project",false]	Whether succesful
POST	/api/io/join/	[sessionId, "EDITOR"]	json, including apiToken

Generate on new location

Set new Project to a 2km by km map size, and its location to latitude 52.080617, longitude 4.312135 (in coordinate system EPSG:4326 ):

	URL	Parameters	Response
POST	api/session/event/editor/clear_map/	[true]	n/a
POST	/api/session/event/editor/set_initial_map_size/	[2000,2000]	n/a
POST	api/session/event/editor/start_map_creation?crs=4326	[4.312135, 52.080617, null, []]	n/a
GET	/api/session/info/		json, including state. "NORMAL" means generation is done

Get results

Data	Calculation
/api/session/wfs/ /api/session/items/neighborhoods?f=GEOJSON /api/session/items/areas?f=GEOJSON	/web/wms/ /api/session/overlay.png?id=overlayId /api/session/overlay.geotiff?id=overlayId /web/indicator.html?id=indicatorId

Notes

• Unless otherwise specified, calls should be accompanied with a query parameter "&f=JSON", to define JSON as the used datastructure in data and responses.
• Any Project can be used as a Template, as long as there is no currently running Session, or the Project is set to read-only.
• All coordinates are x:y, or longitude:latitute. This also includes coordinates in MultiPolygons.
• To add an Area of Interest, in the "start_map_creation" event replace the empty array with an array of MultiPolygons.