Sesijas API

Sesija — izveidot

Darbības joma Nodrošināt, ka tiek izveidota failu apstrādes sesija, kuru pēc tam izmanto, lai atsauktos uz tajā veiktajiem procesiem.

Apraksts
SignAPI izveido sesijas mapi, kas izmanto sesijas ID kā mapes nosaukumu

Pieprasījums
Pakalpojuma sniedzēja lietojumprogramma, izmantojot TLS, nosūta šādu GET pieprasījumu:

GET /api-session/v1.0/start

Parameteri

Nosaukums	Tips	Lietošana	Apraksts
`amount=\{number}`	vaicājums (_query_)	neobligāti	Veidojamo sesiju skaits.

Autorizācija
Pieprasījumā ir jābūt autorizācijas galvenei ar OAuth Introspekta piekļuves marķieri (introspect access token), kas iegūts, izmantojot e-Identity Platform a Service pakalpojumu sniedzēja akreditācijas datu (credentials grant) plūsmu.

Piemērs

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

Atbilde
JSON objekts:

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

Parametrs	Tips	Apraksts
`sessionId`	Virkne (64) (_String (64)_)	Failu apstrādes sesijas identifikators

Piemērs

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

Piemērs ar summas parametru

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

Atbilde

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

Sesija — aizvērt

Darbības joma
Dzēst failu apstrādes sesiju un ar to saistītos dokumentus no atmiņas.

Apraksts

Failu apstrādes sesijā saglabāto un izveidoto failu dzēšana.
Failu apstrādes sesijas direktorija dzēšana.

Pieprasījums
Pakalpojuma sniedzēja lietojumprogramma, izmantojot TLS, nosūta šādu GET pieprasījumu:

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

Parametrs	Tips	Lietošana	Apraksts
`sessionId`	Virkne (64) (_String (64)_)	Obligāts	Sesijas identifikators

Autorizācija
Pieprasījumā ir jābūt autorizācijas galvenei ar OAuth Introspekta piekļuves marķieri (Introspect access token), kas iegūts, izmantojot e-Identitātes platformu, pakalpojuma sniedzēja akreditācijas datu piešķiršanas plūsmu (credentials grant flow).

Piemērs

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

Atbilde
JSON objekts:

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

Parametrs	Tips	Apraksts
`sessionId`	Virkne (_String_)	Failu apstrādes sesijas identifikators

Piemērs

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