Överföring av Web-API-session
Funktionen Överföring av session är avsedd för att överföra användarens val av parter som uträttar ärenden för någon annans räkning från en e-tjänst till en annan.
Då behöver användaren inte själv välja part som uträttar ärenden för någon annans räkning på nytt när hen flyttar från en e-tjänst till en annan. Överföringen är tillgänglig för HPA- och YPA-Web API-sessioner.
Överföring
- Överföring av en session vid uträttande av ärenden för en persons räkning görs enligt följande. Anropsparametrar som innehåller rörliga värden beskrivs i tabellen under exempelanropet.
- E-tjänsten inleder sessionen normalt genom att anropa registreringsgränssnittet, styra användaren till att välja det ärende som ska uträttas för den andra persons räkning och därefter byta den tillfälliga koden till OAuth access token. Den e-tjänst som inlett sessionen begär en överföringskod genom att anropa gränssnittet som startar överföringen:
GET /service/hpa/user/transfer/token/{sessionId}Parameterns namn | Parameterns placering | Parameterns värde |
|---|---|---|
sessionId | URL-parameter | Sessionskod som returnerats vid den ursprungliga registreringen. |
X-FullmakterAuthorization | Rubrik | Kontrollbelopp |
3. Den returnerade överföringskoden (transferToken) förmedlas till den andra e-tjänsten som utför sin egen registrering med hjälp av den överföringskod som erhållits:
GET /service/hpa/user/register/transfer/{transferToken}/{clientId}/{delegateId}=requestId={requestId}Parameterns namn | Parameterns placering | Parameterns värde |
|---|---|---|
transferToken | URL-parameter | Överföringskod som Web-API returnerat till den första e-tjänsten. |
clientId | URL-parameter | Användarnamn för den andra e-tjänsten. |
delegateId | URL-parameter | Kod för den användare som fungerar som ombud. Samma i båda tjänsterna. |
requestId | URL-parameter | Identifikationskod för begäran. T.ex. UUID. |
X-FullmakterAuthorization | Rubrik | Kontrollbelopp. |
4. Användaren omdirigeras till en authorize-adress, varifrån användaren direkt förs tillbaka till tjänstens returadress utan att välja någon som uträttar ärenden för en annans räkning:
GET /oauth/authorize?client_id={clientId}&response_type=code&requestId={requestId}&user={user}&scope=read&state={state}&redirect_uri={redirectUri}&lang={lang}Parameterns namn | Parameterns placering | Parameterns värde |
|---|---|---|
clientId | URL-parameter | Användarnamn för den andra e-tjänsten. |
requestId | URL-parameter | Identifikationskod för begäran. T.ex. UUID. |
user | URL-parameter | Kod som returnerats från registreringen (userId). |
state | URL-parameter | Intern kod för e-tjänsten för transaktionen. T.ex. UUID. |
redirect_uri | URL-parameter | Adressen till e-tjänsten dit användaren hänvisas efter överföringen. |
lang | URL-parameter | Som valfri parameter är användargränssnittets språk: fi, sv eller en. |
5. Den tillfälliga kod som e-tjänsten fått i samband med återgången byts ut till OAuth access token:
POST /oauth/token?grant_type=authorization_code&redirect_uri={redirectUri}&code={code}Parameterns namn | Parameterns placering | Parameterns värde |
|---|---|---|
redirectUri | URL-parameter | Tidigare förmedlad adress dit man just återvänt vid omdirigeringen. |
code | URL-parameter | Kod som förmedlats till e-tjänsten (authorization_code) efter omdirigeringen. |
Authorization | Rubrik | Användarnamn och lösenord. |
6. Den huvudman som valts via den ursprungliga e-tjänsten är nu också vald i den andra e-tjänsten.
Överföringen kan på motsvarande sätt också göras vid uträttande av ärenden för ett företag.
Att observera
När sessionen flyttas ska följande beaktas:
- Sessionerna inleds med samma ombudskod, dvs. ombudet ska vara starkt identifierat i båda e-tjänsterna.
- Ombudets rätt att uträtta ärenden ska kontrolleras på nytt efter överföringen.
- Inställningarna för e-tjänsterna ska vara tillräckligt likadana så att granskningen av ärenderättigheterna lyckas efter överföringen. Företag som uträttar ärenden för alla förhandsvalda ska också återgå till gruppen som uträttar ärenden för någon annan med en annan e-tjänsts regelverk, så att överföringen inte avbryts i urvalsgränssnittet.
- Om utländska personers eller utländska företags koder används ska de finnas i inställningarna för båda tjänsterna och kunna behandlas av e-tjänsterna.
- Överföringen av valen ändrar inte den ursprungliga sessionen.
- Överföringen ska göras innan den ursprungliga sessionen har avslutats med en unregister-inbjudan.
- Överföringskoden gäller i en minut. Om överföringskoden hinner fördröjas innan den registreras, visas rollvalet för användaren i samband med omdirigeringen.