Koplietošanas API

Sākt koplietošanu

Darbības joma
Pievienojiet piekļuves tiesības noteiktai sesijai.

Apraksts

Sesijai tiek pievienota informācija par personu un tās pieejas tiesību līmeni;
Ja persona, kas jau ir piesaistīta sesijai, ir pakļautā persona, informācija tiek labota atbilstoši iesniegtajiem datiem;
Sesija ir iestatīta, lai parādītu, ka tā ir kopīgota.

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

POST /api-share/v1.0/{sessionId}/persons

Parametrs	Tips	Lietošana	Apraksts
`sessionId`	Virkne (64) (String (64))	Obligāts	Failu apstrādes sesijas identifikators

Autorizācija
Pieprasījumā jāiekļauj Authorization galvene ar OAuth Introspekta piekļuves marķieri (Introspect access token), kas iegūts no e-Identitātes platformas, izmantojot pakalpojumu sniedzēja akreditācijas datu piešķiršanas plūsmu (credentials grant flow).

Content-type galvene

Content-Type: application/json

Pamatteksts (body)

{
  "note": {String},
  "persons": [
    {
      "personId": {String},
      "accessRights": {Integer}
    }
  ]
}

Paramters	Apraksts
`personId`	Tās personas identifikators, kurai būs piekļuve šai sesijai
`accessRights`	Piekļuves tiesību līmenis. Sīkāku informāciju skatiet sadaļā"Personu piekļuves saraksta apraksts".
`note`	Papildu informācijas lauks.

Piemērs

POST /api-share/v1/80832540faff3f90246b71122a4bd6896cd50933cc12a22d99a577b7b41d55e2/Persons HTTP/1.1
Authorization: Bearer a477b3a3366768c07e4c458f518711b4b351e8d2c2f0f78a1524e4d3efd00603
Host: signapi-prep.eparaksts.lv
{
  "note": "test",
  "persons": [
    {
      "personId": "111111-11111",
      "accessRights": 5
    }
  ]
}

Atbilde
JSON objekts:

{
  "data": {String}
}

Parametrs	Apraksts
`data`	Informācija par kopīgošanas statusu

Piemērs

{
    "data": "Sharing of the session 6aa64f352666d8a965483527d2bc930fc93ccd3be551a4642cd8a6631b97ee89 changed. 1 persons added, rights for 0 persons modified. With note= test"
}

Pārtraukt koplietošanu

Darbības joma
Noņemiet piekļuves tiesības no konkrētās sesijas.

Apraksts

Personas piekļuves tiesības sesijai tiek noņemtas
Ja nav citu personu, ar kurām tiek koplietota sesija, statuss "koplietots" tiek noņemts no sesijas.

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

DELETE /api-share/v1.0/{sessionId}/persons/{personId}

Parametrs	Apraksts
`sessionId`	Failu apstrādes sesijas identifikators
`personId`	Personas identifikators

Piemērs

DELETE /api-share/v1/80832540faff3f90246b71122a4bd6896cd50933cc12a22d99a577b7b41d55e2/Persons/111111-11111 HTTP/1.1
Authorization: Bearer a477b3a3366768c07e4c458f518711b4b351e8d2c2f0f78a1524e4d3efd00603
Host: signapi-prep.eparaksts.lv

Atbilde
JSON objekts:

Parametrs	Apraksts
`data`	Informācija par darbības statusu

Piemērs

{
    "data": "Sharing of the session 552825f4eafdbf90a676ea40c4802c9d1f27c20373c2594c0dfe950976ce2b19 removed for 1 person"
}

Personas sesijā

Darbības joma
Uzziniet personas, ar kurām tiek kopīgota sesija

Apraksts
Atgriež sarakstu ar personām, kuras ir saistītas ar sesiju.

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

GET /api-share/v1.0/{sessionId}/persons

Parametrs	Tips	Lietošana	Apraksts
`sessionId`	Virne (64) (String (64))	Obligāts	Failu apstrādes sesijas identifikators

Piemērs

GET /api-share/v1/552825f4eafdbf90a676ea40c4802c9d1f27c20373c2594c0dfe950976ce2b19/Persons HTTP/1.1
Authorization: Bearer a477b3a3366768c07e4c458f518711b4b351e8d2c2f0f78a1524e4d3efd00603
Host: signapi-prep.eparaksts.lv

Atbilde
JSON objekts:

{
  "data": [
    {
      "personId": {String},
      "accessRights": {Integer}
    }
  ]
}

Parametrs	Apraksts
`personId`	Tās personas identifikators, kurai būs piekļuve šai sesijai
`accessRights`	Piekļuves tiesību līmenis. Sīkāku informāciju skatiet sadaļā "Personu piekļuves saraksta apraksts".

Piemērs

{
    "data": [
        {
            "personId": "111111-11111",
            "accessRights": 5
        },
        {
            "personId": "222222-22222",
            "accessRights": 1
        }
    ]
}

Personas sesijas

Darbības joma
Uzziniet sesijas, kas tiek kopīgotas ar konkrēto personu.

Apraksts
Atgriež ar personu saistīto sesiju sarakstu.

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

GET /api-share/v1.0/{personId}/sessions

Parametrs	Apraksts
`personId`	Personas identifikators

Piemērs

GET /api-share/v1/111111-111111/Sessions HTTP/1.1
Authorization: Bearer a477b3a3366768c07e4c458f518711b4b351e8d2c2f0f78a1524e4d3efd00603
Host: signapi-prep.eparaksts.lv

Atbilde
JSON objekts:

{
  "data": [
    {
      "sessionId": {String},
      "fileCount": {Integer},
      "personCount": {Integer},
      "signed": {Integer},
      "shared": {Boolean},
      "archived": {Boolean},
      "signedFileType": {String},
      "lastModified": {String},
      "removalTime":{String}
    }
  ]
}

Parametrs	Apraksts
`sessionId`	Failu apstrādes sesijas identifikators
`fileCount`	Faila apjoms sesijā
`personCount`	Cilvēku skaits, ar kuriem sesija tika kopīgota
`signed`	Sesijas parakstīšanas statuss: 0 - faili ir ielādēti, bet nav parakstīti 1 - jau parakstītie faili ir ielādēti 2 - faili parakstīti
`shared`	Kopīgošanas statusi: `false` - sesija netiek kopīgota `true` - sesija tiek kopīgota
`archived`	Arhīva laika zīmoga statusi: `false` - nesatur arhīva laika zīmogu `true` - satur arhīva laika zīmogu
`signedFileType`	Ja parakstīts, parāda parakstītā faila formātu
`lastModified`	Pēdējā faila apstrādes pieprasījuma laiks
`removalTime`	Paredzamais procesa dzēšanas laiks

Piemērs

{
    "data": [
        {
            "sessionId": "552825f4eafdbf90a676ea40c4802c9d1f27c20373c2594c0dfe950976ce2b19",
            "fileCount": 0,
            "personCount": 2,
            "signed": 0,
            "shared": false,
            "archived": false,
            "lastModified": "0001-01-01T00:00:00",
            "removalTime": "0001-01-01T00:00:00"
        },
        {
            "sessionId": "1d72da6fd2d71810f96d04e9261bee6f3b01eaba95ed9b25be0cd6230910902b",
            "fileCount": 0,
            "personCount": 1,
            "signed": 0,
            "shared": false,
            "archived": false,
            "lastModified": "0001-01-01T00:00:00",
            "removalTime": "0001-01-01T00:00:00"
        }
    ]
}

Personu piekļuves saraksta apraksts

Parametrs Apraksts

Parametrs	Apraksts
`accessRights`	Piekļuves tiesību vērtības: 1 - Parakstīt 2 - Dzēst 4 - Lasīt 8 - Dalīties/Koplietot 16 - Rezervēt ⚠️ `accessRights` vērtība ir visu nepieciešamo darbību summa. Vērtība ir no "0" (bez piekļuves tiesību) līdz "31" (Parakstīt+Dzēst+Lasīt+Kopīgot+Rezervēts). ⚠️

accessRights

Piekļuves tiesību vērtības:

1 - Parakstīt

2 - Dzēst

4 - Lasīt

8 - Dalīties/Koplietot

16 - Rezervēt

⚠️ accessRights vērtība ir visu nepieciešamo darbību summa. Vērtība ir no "0" (bez piekļuves tiesību) līdz "31" (Parakstīt+Dzēst+Lasīt+Kopīgot+Rezervēts). ⚠️