Session API

Session - Create

Scope
Ensure that a file processing session is created, which is then used to refer to the processes it takes.

Description
SignAPI creates a session folder that uses the session ID as folder name

Request
The Service provider's application sends the following GET request using TLS:

GET /api-session/v1.0/start

Parameters

Name	Type	Usage	Description
amount={number}	query	optional	Amount of sessions to be created.

Authorization
The request must contain an Authorization header with an OAuth Introspect access token obtained via Integration Platform a Service provider's credentials grant flow.

Example

GET /api-session/v1.0/start HTTP/1.1
Authorization: Bearer a477b3a3366768c07e4c458f518711b4b351e8d2c2f0f78a1524e4d3efd00603
Host: signapi-prep.eparaksts.lv

Response
JSON object:

{
    "data": {
        "sessionId": {string}
    }
}

Property	Type	Description
sessionId	String (64)	File processing session identifier

Example

{
    "data": {
        "sessionId": "5a1ef5321d1bd9a2966d673c84c7ded630a1923965e3efcfc1787260cbe8223d"
    }
}

Example with amount parameter

GET /api-session/v1.0/start?amount=3 HTTP/1.1
Authorization: Bearer c9031ccc32ef1a9293dc3d4a8011f42aafa3abfd71330ff349e4b4101bf252b9
Host: signapi-prep.eparaksts.lv

Response

{
    "data": {
        "sessionIds": [
            "362a009ad18a67aa6f4c2f8762720dfe2c5f0f554816cb19a73b95f2835a6674",
            "97eb1b5c8b4f357f830fbb1ff964037bd17c358be7908e59a4958f39d4c1c0b1",
            "3ede379992f156f3acf010b4d2391b369bd804b64403ab4bab770ac3d200bc17"
        ]
    }
}

Session - Close

Scope
Delete file processing session and related documents from memory.

Description

Deleting files stored and created in the file processing session.
Deleting the file processing session directory.

Request
The Service provider's application sends the following GET request using TLS:

GET /api-session/v1.0/{sessionId}/close

Property	Type	Usage	Description
sessionId	String (64)	Mandatory	Session identifier

Authorization
The request must contain an Authorization header with an OAuth Introspect access token obtained via Integration Platform a Service provider's credentials grant flow.

Example

GET /api-session/v1.0/77740b301f0880ef498cb1e474e8060b3e538cfeea8ebf508c2bad4b72b56a87/close HTTP/1.1
Authorization: Bearer a477b3a3366768c07e4c458f518711b4b351e8d2c2f0f78a1524e4d3efd00603
Host: signapi-prep.eparaksts.lv

Response
JSON object:

{
    "data": "Session {sessionId} closed"
}

Property	Type	Description
sessionId	String	File processing session identifier

Example

{
    "data": "Session 77740b301f0880ef498cb1e474e8060b3e538cfeea8ebf508c2bad4b72b56a87 closed"
}