API tutorial - Revision history

Maxim@tygron.com: /* Use GeoTIFF as heightmap */

2023-03-02T15:55:57Z

Use GeoTIFF as heightmap

← Older revision		Revision as of 15:55, 2 March 2023
Line 890:		Line 890:

	===Use GeoTIFF as heightmap===		===Use GeoTIFF as heightmap===
	To base the heightmap on a GeoTIFF, first a GeoTIFF must be uploaded.		To base the heightmap on a [[GeoTIFF]], first a GeoTIFF must be uploaded.

	After uploading the GeoTIFF, the map must be modified based on the GeoTIFF.		After uploading the GeoTIFF, the map must be modified based on the GeoTIFF.
Line 904:		Line 904:
	}}		}}

	Applying the GeoTIFF to the heightmap is a singular action. When doing so, the GeoTIFF as it is in that moment is used to redraw the heightmap. After this action is completed, there is no explicit link between the height map and the GeoTIFF. This means that if or when the GeoTIFF is updated afterwards, the heightmap does not "follow" that same modification automatically. The event should be used again to update the heightmap to the new state of the GeoTIFF, if it is so desired.		Applying the [[GeoTIFF]] to the heightmap is a singular action. When doing so, the GeoTIFF as it is in that moment is used to redraw the heightmap. After this action is completed, there is no explicit link between the height map and the GeoTIFF. This means that if or when the GeoTIFF is updated afterwards, the heightmap does not "follow" that same modification automatically. The event should be used again to update the heightmap to the new state of the GeoTIFF, if it is so desired.
	{{page break}}		{{page break}}

Maxim@tygron.com: /* Miscellaneous tasks via the API */

2023-03-02T15:54:30Z

Miscellaneous tasks via the API

← Older revision		Revision as of 15:54, 2 March 2023
Line 887:		Line 887:
	All tasks can be performed via the API. However, for some tasks the appropriate events and their parameters may not be directly apparent.		All tasks can be performed via the API. However, for some tasks the appropriate events and their parameters may not be directly apparent.

	As a general rule of thumb, to perform any task via the API, it can be beneficial to perform the task in the client of the {{software}} first, and take note of the kind of steps taken to complete the full task.		As a general rule of thumb, to perform any task via the API, it can be beneficial to perform the task in the {{software\|client}} of the {{software}} first, and take note of the kind of steps taken to complete the full task.

	===Use GeoTIFF as heightmap===		===Use GeoTIFF as heightmap===

Maxim@tygron.com: /* Sessions */

2023-03-02T15:53:06Z

Sessions

← Older revision		Revision as of 15:53, 2 March 2023
Line 379:		Line 379:
	* $USERNAME: your username		* $USERNAME: your username
	* $KEY: the login key retrieved earlier		* $KEY: the login key retrieved earlier
	* $PROJECT: the filename of the project you wish to start~~. "climategame_5_1" is universally available~~.		* $PROJECT: the filename of the project you wish to start.
	{{code\|1=var USERNAME = $USERNAME;		{{code\|1=var USERNAME = $USERNAME;
	var PASSWORD = $KEY;		var PASSWORD = $KEY;

Maxim@tygron.com: /* Root API */

2023-03-02T15:52:40Z

Root API

← Older revision		Revision as of 15:52, 2 March 2023
Line 347:		Line 347:
	Switch to the JSON format. Note that more information is available.		Switch to the JSON format. Note that more information is available.

	Just like with the session API, the root API allows you to fire events as instruction to the {{software}}. Go back to the "/api/", and go to "Fire Service Event". Next, select "IO" (which stands for "IO Service Events").		Just like with the session API, the root API allows you to fire events as instruction to the {{software\|server}}. Go back to the "/api/", and go to "Fire Service Event". Next, select "IO" (which stands for "IO Service Events").

	Select the event "GET_DOMAIN_STARTABLE_PROJECTS". Enter the name of your domain, and fire the event. The response will be a list of all projects which can be started by your user in your domain.		Select the event "GET_DOMAIN_STARTABLE_PROJECTS". Enter the name of your domain, and fire the event. The response will be a list of all projects which can be started by your user in your domain.

Maxim@tygron.com: /* Introduction to the API */

2023-03-02T15:51:39Z

Introduction to the API

← Older revision		Revision as of 15:51, 2 March 2023
Line 8:		Line 8:

	==Introduction to the API==		==Introduction to the API==
	The {{software\|server}} offers access via an API, allowing for external applications to interact with and use the {{software\|server}}. The API is an integral part of the functioning of the {{software}}, in that the default client ~~application~~ uses it as well. This means the API can allow you to do anything that the {{software\|client}} ~~application~~ allows you to do as well.		The {{software\|server}} offers access via an API, allowing for external applications to interact with and use the {{software\|server}}. The API is an integral part of the functioning of the {{software}}, in that the default {{software\|client}} app uses it as well. This means the API can allow you to do anything that the {{software\|client}} app allows you to do as well.

	The API can be used to:		The API can be used to:

Maxim@tygron.com: /* Introduction to the API */

2023-03-02T15:50:51Z

Introduction to the API

← Older revision		Revision as of 15:50, 2 March 2023
Line 8:		Line 8:

	==Introduction to the API==		==Introduction to the API==
	The {{software}} offers access via an API, allowing for external applications to interact with and use the {{software}}. The API is an integral part of the functioning of the {{software}}, in that the default client application uses it as well. This means the API can allow you to do anything that the client application allows you to do as well.		The {{software\|server}} offers access via an API, allowing for external applications to interact with and use the {{software\|server}}. The API is an integral part of the functioning of the {{software}}, in that the default client application uses it as well. This means the API can allow you to do anything that the {{software\|client}} application allows you to do as well.

	The API can be used to:		The API can be used to:
Line 14:		Line 14:
	* Automate menial and complex tasks		* Automate menial and complex tasks
	* Integrate the output of external applications in projects and sessions automatically		* Integrate the output of external applications in projects and sessions automatically
	* Integrate the {{software}} with an existing process chain		* Integrate the {{software\|server}} with an existing process chain

	Overall, the API is split into two separate sections, a root API and a session API. The root API is for access to the {{software}} in general, and can be used to access user information or domain information, start and save projects, and manage access rights. The session API is for interactions with a specific session, modifying the data in it, or obtaining results as calculated in the Session.		Overall, the API is split into two separate sections, a root API and a session API. The root API is for access to the {{software\|server}} in general, and can be used to access user information or domain information, start and save projects, and manage access rights. The session API is for interactions with a specific session, modifying the data in it, or obtaining results as calculated in the Session.

	The API can be accessed via a web browser, allowing for easy inspection of the data and options.		The API can be accessed via a web browser, allowing for easy inspection of the data and options.

	{{page_break}}		{{page_break}}

	==Session API==		==Session API==
	Start a project in the editor. In the [[Tools]] ribbon tab, click on the [[API Overview]].		Start a project in the editor. In the [[Tools]] ribbon tab, click on the [[API Overview]].

Frank@tygron.nl: /* Requesting updated data */

2023-02-21T17:08:37Z

Requesting updated data

← Older revision		Revision as of 17:08, 21 February 2023
Line 214:		Line 214:
	{{page_break}}		{{page_break}}
	===Requesting updated data===		===Requesting updated data===
	Besides actively requesting information, and interacting with a project[[ session]] yourself, it can also be important to be able to recognize when the session is affected by others. This can include:		Besides actively requesting information, and interacting with a project [[session]] yourself, it can also be important to be able to recognize when the session is affected by others. This can include:
	* The completion of a calculation running on the server		* The completion of a calculation running on the server
	* Another user modifying data in a session, either by editing or as an in-session action.		* Another user modifying data in a session, either by editing or as an in-session action.

Frank@tygron.nl: /* Requesting updated data */

2023-02-21T17:08:28Z

Requesting updated data

← Older revision		Revision as of 17:08, 21 February 2023
Line 214:		Line 214:
	{{page_break}}		{{page_break}}
	===Requesting updated data===		===Requesting updated data===
	Besides actively requesting information, and interacting with a project yourself, it can also be important to be able to recognize when the session is affected by others. This can include:		Besides actively requesting information, and interacting with a project[[ session]] yourself, it can also be important to be able to recognize when the session is affected by others. This can include:
	* The completion of a calculation running on the server		* The completion of a calculation running on the server
	* Another user modifying data in a session, either by editing or as an in-session action.		* Another user modifying data in a session, either by editing or as an in-session action.

Frank@tygron.nl: /* HTML and JSON */

2023-02-21T17:07:54Z

HTML and JSON

← Older revision		Revision as of 17:07, 21 February 2023
Line 73:		Line 73:
	Go to the list of neighborhoods, and select the JSON format.		Go to the list of neighborhoods, and select the JSON format.

	Notice the list of all neighborhoods is now in ~~JSON~~ format, without any HTML layout or styling. This is the format which can most easily be processed by your own code.		Notice the list of all neighborhoods is now in [[GeoJSON]] format, without any HTML layout or styling. This is the format which can most easily be processed by your own code.
	{{page_break}}		{{page_break}}

Frank@tygron.nl: /* Inspecting data */

2023-02-21T17:07:39Z

Inspecting data

← Older revision		Revision as of 17:07, 21 February 2023
Line 37:		Line 37:
	The session API allows for the inspection of data in a project. This data can be found in the "Content items" listing.		The session API allows for the inspection of data in a project. This data can be found in the "Content items" listing.
	* In the editor, select a neighborhood		* In the editor, select a neighborhood
	* In the web browser with the API opened, go to the "Content items" listing. Find the "Neighborhoods", and then the neighborhood selected in the editor.		* In the web browser with the API opened, go to the "Content items" listing. Find the "Neighborhoods", and then the [[neighborhood]] selected in the editor.
	* Take note of the data in the neighborhood item matching the data displayed in the editor.		* Take note of the data in the neighborhood item matching the data displayed in the editor.
	* In the editor, change the name of the neighborhood		* In the editor, change the name of the neighborhood