REST API - Revision history

Maxim@tygron.com: Reverted edit by Rudolf@tygron.nl (talk) to last revision by Maxim@tygron.com

2026-04-23T14:26:04Z

Reverted edit by Rudolf@tygron.nl (talk) to last revision by Maxim@tygron.com

← Older revision		Revision as of 14:26, 23 April 2026
Line 151:		Line 151:

	====Keeping session active====		====Keeping session active====
	The server will automatically close a session which has not been interacted with by a known client for 15 minutes (depending on whether [[~~Keep Alive~~]] is active). An application can should include a client token with all POST requests it makes to indicate that the application is still actively connected and interacting with the session. If it is necessary to keep the session active without affecting it by firing events, it is possible to use the update polling feature, which is also accessed via POST requests. This will only request data from the session without changing it, and will be recognized as an interaction from the application.		The server will automatically close a session which has not been interacted with by a known client for 15 minutes (depending on whether [[keep alive]] is active). An application can should include a client token with all POST requests it makes to indicate that the application is still actively connected and interacting with the session. If it is necessary to keep the session active without affecting it by firing events, it is possible to use the update polling feature, which is also accessed via POST requests. This will only request data from the session without changing it, and will be recognized as an interaction from the application.

	==Software Development Kit (BETA)==		==Software Development Kit (BETA)==

Rudolf@tygron.nl at 11:51, 23 April 2026

2026-04-23T11:51:01Z

← Older revision		Revision as of 11:51, 23 April 2026
Line 151:		Line 151:

	====Keeping session active====		====Keeping session active====
	The server will automatically close a session which has not been interacted with by a known client for 15 minutes (depending on whether [[~~keep alive~~]] is active). An application can should include a client token with all POST requests it makes to indicate that the application is still actively connected and interacting with the session. If it is necessary to keep the session active without affecting it by firing events, it is possible to use the update polling feature, which is also accessed via POST requests. This will only request data from the session without changing it, and will be recognized as an interaction from the application.		The server will automatically close a session which has not been interacted with by a known client for 15 minutes (depending on whether [[Keep Alive]] is active). An application can should include a client token with all POST requests it makes to indicate that the application is still actively connected and interacting with the session. If it is necessary to keep the session active without affecting it by firing events, it is possible to use the update polling feature, which is also accessed via POST requests. This will only request data from the session without changing it, and will be recognized as an interaction from the application.

	==Software Development Kit (BETA)==		==Software Development Kit (BETA)==

Maxim@tygron.com: /* Session Tokens */

2026-04-09T07:38:57Z

Session Tokens

← Older revision		Revision as of 07:38, 9 April 2026
Line 47:		Line 47:

	{{code\|1=?token=92043566V433Q8UdMO9ThDanINnTNOIX}}		{{code\|1=?token=92043566V433Q8UdMO9ThDanINnTNOIX}}

			The token can also be set via the Authorization header as Bearer token, for example:

			{{code\|1=Authorization: Bearer 92043566V433Q8UdMO9ThDanINnTNOIX}}

	===Navigating the API===		===Navigating the API===

Maxim@tygron.com: /* Starting and stopping sessions */

2026-04-09T07:36:25Z

Starting and stopping sessions

← Older revision		Revision as of 07:36, 9 April 2026
Line 133:		Line 133:
	There are multiple events involved in having your application neatly interact with a session on the server.		There are multiple events involved in having your application neatly interact with a session on the server.

	* io/start: This event starts a project on the server. No interaction takes place yet. If the project is already opened in Editor mode, it cannot be opened again, either in an Editor or as a playable session, until the session is closed. If the project has been opened in Single User or Multi User mode, the project cannot be edited until all the playable sessions have closed.		* /api/io/start: This event starts a project on the server. No interaction takes place yet. If the project is already opened in Editor mode, it cannot be opened again, either in an Editor or as a playable session, until the session is closed. If the project has been opened in Single User or Multi User mode, the project cannot be edited until all the playable sessions have closed.

	* io/get_joinable_sessions This event lists all currently running sessions which you are able to join.		* /api/io/get_joinable_sessions This event lists all currently running sessions which you are able to join.

	* io/join: This event provides you with tokens you can use to join the project. The token is necessary to interact with the specific project. The clientToken identifies your program to the server, allowing it to recognize there is a client interacting with the project. If no clients interact with a project for too long, the sessions closes automatically.		* /api/io/join: This event provides you with tokens you can use to join the project. The token is necessary to interact with the specific project. The clientToken identifies your program to the server, allowing it to recognize there is a client interacting with the project. If no clients interact with a project for too long, the sessions closes automatically.

	* io/close: This event lets the server know your application has left the session. This means any stakeholder you have selected is freed up for another client, and the server no longer considers your client part of the session. When all clients have left a session, the session can be closed immediately, or times out after a set period.		* /api/io/close: This event lets the server know your application has left the session. This means any stakeholder you have selected is freed up for another client, and the server no longer considers your client part of the session. When all clients have left a session, the session can be closed immediately, or times out after a set period.

	* io/kill: This event terminates a session immediately.		* /api/io/kill: This event terminates a session immediately.

	====Session data and interaction====		====Session data and interaction====

Maxim@tygron.com: /* Login key */

2026-04-09T07:35:56Z

← Older revision		Revision as of 07:35, 9 April 2026
Line 37:		Line 37:
	=====Login key=====		=====Login key=====
	After authentication, it is [[API tutorial#Authenticating via login key\|proper practise to obtain the user login key]] and authenticate using that in lieu of the password. This is to prevent repeated exposure of re-usable credentials. The login key can be obtained at the following url:		After authentication, it is [[API tutorial#Authenticating via login key\|proper practise to obtain the user login key]] and authenticate using that in lieu of the password. This is to prevent repeated exposure of re-usable credentials. The login key can be obtained at the following url:
	{{code\|1=/api~~/event~~/user/get_my_login_key/}}		{{code\|1=/api/user/get_my_login_key}}

	====Session Tokens====		====Session Tokens====

Maxim@tygron.com: /* Software Development Kit */

2026-04-09T07:35:12Z

Software Development Kit

← Older revision		Revision as of 07:35, 9 April 2026
Line 149:		Line 149:
	The server will automatically close a session which has not been interacted with by a known client for 15 minutes (depending on whether [[keep alive]] is active). An application can should include a client token with all POST requests it makes to indicate that the application is still actively connected and interacting with the session. If it is necessary to keep the session active without affecting it by firing events, it is possible to use the update polling feature, which is also accessed via POST requests. This will only request data from the session without changing it, and will be recognized as an interaction from the application.		The server will automatically close a session which has not been interacted with by a known client for 15 minutes (depending on whether [[keep alive]] is active). An application can should include a client token with all POST requests it makes to indicate that the application is still actively connected and interacting with the session. If it is necessary to keep the session active without affecting it by firing events, it is possible to use the update polling feature, which is also accessed via POST requests. This will only request data from the session without changing it, and will be recognized as an interaction from the application.

	==Software Development Kit==		==Software Development Kit (BETA)==
	To make working with the API easier, Tygron also offers a Software Development Kit. This is a library which can be used while developing your application, with functionality for creating and maintaining a connection with the {{software}}, parsing data requested via the API, and performing tasks in a similar manner as users do via the Client. The current version of the SDK is available here: [https://engine.tygron.com/api/developer/ SDK]. Note that you need to have active {{software}} login credentials to make us of this SDK.		To make working with the API easier, Tygron also offers a Software Development Kit. This is a library which can be used while developing your application, with functionality for creating and maintaining a connection with the {{software}}, parsing data requested via the API, and performing tasks in a similar manner as users do via the Client. The current version of the SDK is available here: [https://engine.tygron.com/api/developer/ SDK]. Note that you need to have active {{software}} login credentials to make us of this SDK.

	A Python SDK is also available from Github:		A Python SDK (BETA) is also available from Github:

	https://github.com/Tygron/python-tygronsdk		https://github.com/Tygron/python-tygronsdk

Maxim@tygron.com: /* Starting and stopping sessions */

2026-04-09T07:34:37Z

Starting and stopping sessions

← Older revision		Revision as of 07:34, 9 April 2026
Line 133:		Line 133:
	There are multiple events involved in having your application neatly interact with a session on the server.		There are multiple events involved in having your application neatly interact with a session on the server.

	* ~~IOServicesEventType.START_NEW_SESSION~~: This event starts a project on the server. No interaction takes place yet. If the project is already opened in Editor mode, it cannot be opened again, either in an Editor or as a playable session, until the session is closed. If the project has been opened in Single User or Multi User mode, the project cannot be edited until all the playable sessions have closed.		* io/start: This event starts a project on the server. No interaction takes place yet. If the project is already opened in Editor mode, it cannot be opened again, either in an Editor or as a playable session, until the session is closed. If the project has been opened in Single User or Multi User mode, the project cannot be edited until all the playable sessions have closed.

	* ~~IOServicesEventType.GET_JOINABLE_SESSIONS:~~ This event lists all currently running sessions which you are able to join.		* io/get_joinable_sessions This event lists all currently running sessions which you are able to join.

	* ~~IOServicesEventType.JOIN_SESSION~~: This event provides you with tokens you can use to join the project. The token is necessary to interact with the specific project. The clientToken identifies your program to the server, allowing it to recognize there is a client interacting with the project. If no clients interact with a project for too long, the sessions closes automatically.		* io/join: This event provides you with tokens you can use to join the project. The token is necessary to interact with the specific project. The clientToken identifies your program to the server, allowing it to recognize there is a client interacting with the project. If no clients interact with a project for too long, the sessions closes automatically.

	* ~~IOServicesEventType.CLOSE_SESSION~~: This event lets the server know your application has left the session. This means any stakeholder you have selected is freed up for another client, and the server no longer considers your client part of the session. When all clients have left a session, the session can be closed immediately, or times out after a set period.		* io/close: This event lets the server know your application has left the session. This means any stakeholder you have selected is freed up for another client, and the server no longer considers your client part of the session. When all clients have left a session, the session can be closed immediately, or times out after a set period.

	* ~~IOServicesEventType.KILL_SESSION~~: This event terminates a session immediately.		* io/kill: This event terminates a session immediately.

	====Session data and interaction====		====Session data and interaction====

Maxim@tygron.com: /* JSON response example */

2026-04-09T07:32:58Z

JSON response example

← Older revision		Revision as of 07:32, 9 April 2026
Line 88:		Line 88:

	====JSON response example====		====JSON response example====
	{{code\|1=POST /api~~/services~~/event/~~IOServicesEventType~~/~~START_NEW_SESSION~~/?f=JSON HTTP/1.1		{{code\|1=POST /api/event/io/start/?f=JSON HTTP/1.1
	Host: engine.tygron.com		Host: engine.tygron.com
	Content-Type: application/json		Content-Type: application/json

Maxim@tygron.com: /* HTML response example */

2026-04-09T07:32:48Z

HTML response example

← Older revision		Revision as of 07:32, 9 April 2026
Line 70:		Line 70:
	{{code\|1=		{{code\|1=
	HEADERS:		HEADERS:
	POST /api~~/services~~/event/~~IOServicesEventType~~/~~START_NEW_SESSION~~/ HTTP/1.1		POST /api/event/io/start/ HTTP/1.1
	Host: engine.tygron.com		Host: engine.tygron.com
	Content-Type: application/x-www-form-urlencoded		Content-Type: application/x-www-form-urlencoded

Frank@tygron.nl at 11:04, 31 March 2026

2026-03-31T11:04:37Z

← Older revision		Revision as of 11:04, 31 March 2026
Line 162:		Line 162:
	* [[API tutorial]]		* [[API tutorial]]
	* [[API Template usage cheatsheet]]		* [[API Template usage cheatsheet]]
	* [[~~API~~ Events]]		* [[Api Events]]
	}}		}}

	[[Category:API]]		[[Category:API]]