Sākumlapa/Api
Session
Šajā sadaļā ir aprakstīti soļi sesijas uzsākšanai un konfigurēšanai Ramus Accountant API.
1. Lietotāja autorizācija (Login)
Pieprasījums, lai iegūtu sesijas ID un API atslēgu.
Curl: <syntaxhighlight lang="bash"> curl -X 'POST' \
'https://demo.ramusnet.eu/ramusAccountant/service/api/session/login/user' \ -H 'accept: */*' \ -H 'Content-Type: application/json' \ -d '{ "usernameOrEmail": "vards.uzvards@pasts.lv", "password": "?????????"
}' </syntaxhighlight>
Request URL:
https://demo.ramusnet.eu/ramusAccountant/service/api/session/login/user
Response body: <syntaxhighlight lang="json"> {
"error": false, "message": "Logged In", "sessionId": "D821FE10B0C80B72D8A471E6C19BD18B", "apiKey": "Ramus eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiJqdXJpcy5wb2RzQGdtYWlsLmNvbSIsImlhdCI6MTcyMzY0MTAzNCwiZXhwIjoxNzIzNjg0MjMzfQ.Dosm3U8y-d73JE9EUHA3eAJOZutsaA1hkG48S2jMc1rR-00xGscz_iCuumIl7BlV"
} </syntaxhighlight>
---
2. Darba vides (Workspace) atrašana
Iegūst pieejamo darba vidi sarakstu izmantojot saņemto sesiju.
Curl: <syntaxhighlight lang="bash"> curl -X 'GET' \
'https://demo.ramusnet.eu/ramusAccountant/service/api/session/find' \ -H 'accept: application/json' \ -H 'query: { "sessionId": "D821FE10B0C80B72D8A471E6C19BD18B", "workspaceName": "PARAUGS" }' \ -H 'Authorization: Ramus eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiJqdXJpcy5wb2RzQGdtYWlsLmNvbSIsImlhdCI6MTcyMzY0MTAzNCwiZXhwIjoxNzIzNjg0MjMzfQ.Dosm3U8y-d73JE9EUHA3eAJOZutsaA1hkG48S2jMc1rR-00xGscz_iCuumIl7BlV'
</syntaxhighlight>
Request URL:
https://demo.ramusnet.eu/ramusAccountant/service/api/session/find
Response body: <syntaxhighlight lang="json"> {
"workspaces": [
{
"serverDataSourceId": 1001,
"name": "demo.ramusnet.lv",
"data": {
"total": 1,
"rows": [
{
"userId": 144332002024,
"workspace": "PARAUGS",
"workspaceId": 150734769495,
"registrationNr": "40103659822"
}
]
}
}
]
} </syntaxhighlight>
---
3. Finanšu periodu atrašana
Iegūst sarakstu ar pieejamajiem gadiem/periodiem konkrētajā darba vidē.
Curl: <syntaxhighlight lang="bash"> curl -X 'GET' \
'https://demo.ramusnet.eu/ramusAccountant/service/api/session/find/periods' \ -H 'accept: application/json' \ -H 'query: { "sessionId": "D821FE10B0C80B72D8A471E6C19BD18B", "serverDataSourceId": "1001", "workspaceId": "150734769495" }' \ -H 'Authorization: Ramus eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiJqdXJpcy5wb2RzQGdtYWlsLmNvbSIsImlhdCI6MTcyMzY0MTAzNCwiZXhwIjoxNzIzNjg0MjMzfQ.Dosm3U8y-d73JE9EUHA3eAJOZutsaA1hkG48S2jMc1rR-00xGscz_iCuumIl7BlV'
</syntaxhighlight>
Response body (saīsināts): <syntaxhighlight lang="json"> {
"financialPeriod": [
{
"serverDataSourceId": 1001,
"code": "DEMO",
"data": [
{
"financialPeriodId": 710951063977,
"code": "2024",
"from": "01.01.2024",
"till": "31.12.2024"
}
]
}
]
} </syntaxhighlight>
---
4. Sesijas saglabāšana (Store)
Iestata aktīvo darba vidi un finanšu periodu tekošajai sesijai.
Curl: <syntaxhighlight lang="bash"> curl -X 'POST' \
'https://demo.ramusnet.eu/ramusAccountant/service/api/session/store' \ -H 'accept: application/json' \ -H 'query: { "sessionId": "D821FE10B0C80B72D8A471E6C19BD18B", "serverDataSourceId": "1001", "workspaceId": "150734769495", "financialPeriodId": "641738108062" }' \ -H 'Authorization: Ramus eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiJqdXJpcy5wb2RzQGdtYWlsLmNvbSIsImlhdCI6MTcyMzY0MTAzNCwiZXhwIjoxNzIzNjg0MjMzfQ.Dosm3U8y-d73JE9EUHA3eAJOZutsaA1hkG48S2jMc1rR-00xGscz_iCuumIl7BlV' \ -d
</syntaxhighlight>
Response body: <syntaxhighlight lang="json"> {
"success": true,
"subject": {
"userId": "144332002024",
"workspaceId": "150734769495",
"financialPeriodId": "641738108062",
"sesionId": "D821FE10B0C80B72D8A471E6C19BD18B"
}
} </syntaxhighlight>