S3D.session
The S3D.session namespace provides functions to manage a session with the API.
S3D.session.start#
At the beginning of every API session, the S3D.session.start function must be the first function in the array. This initiates a session and will return a session_id which can be used in subsequent calls made in the following 30 minutes to skip the verification process, thereby dramatically reducing the time to response.
important
S3D.session.start must always be the first function even if session_id is provided.
| Key | Type | Accepts | Description | Default |
|---|---|---|---|---|
keep_open | boolean | true, false | If the session should be kept on standby. If true, subsequent calls to the API using the session_id provided from the first call in lieu of key, will be 4-8x faster. | false |
After authenticating using the API key, the response object will contain some useful information. The session_id key can be used to make further calls to the same session, skipping authentication if keep_open was set to true. The session_expiry_time provides an approximate Unix time until the session expires. After this, the user must re-authenticate using their API key.
tip
The returned session_id can be provided in the auth object of subsequent calls to make the request faster.