Page History
...
Login user
| Code Block | ||
|---|---|---|
| ||
POST /api/v1v2/login |
Description
Log the user in with the provided credentials
Parameters
| URL Segment | Expected Type | Description |
|---|---|---|
| username | string | Username of the user to login. |
| password | string | Password of the user to login. |
Response
204 No Content, if successful.
401 Unauthorized, if unsuccessful.
...
Logout user
| Code Block | ||
|---|---|---|
| ||
POST /api/v1v2/logout |
Description
Logout the current user and close all Blueriq sessions
Response
204 No Content
Starting a Blueriq session
Start Shortcut
| Code Block |
|---|
POST /api/v1v2/start/{shortcutName?} |
Description
Starts a session by specifying the name of a shortcut.
Parameters
| URL Segment | Expected Type | Description |
|---|---|---|
| shortcutName | string | The shortcut name, leave empty to start the default shortcut |
Example response
| Code Block |
|---|
{
"subscriptionId": "2f177274-514d-4be9-aa3d-4a550ab9e724",
"sessionId": "2f177274-514d-4be9-aa3d-4a550ab9e724",
"sessionTimeout": 1800
} |
Start Project
| Code Block |
|---|
POST /api/v1v2/start?project=export-kinderbijslag&flow=Main |
Description
Starts a session with project parameters. This endpoint may be disabled in production for security reasons, so using shortcuts is preferred.
Parameters
| Query parameter | Expected Type | Description | Required |
|---|---|---|---|
| project | string | The project to start | Yes |
flow | string | The flow to start | Only required if more than one exposed flow is present in the project |
| version | string | The branch version | No |
| languageCode | string | The project language | No |
| ui | string | The UI variant to use, by default only mvc and xslt is supported | No |
| theme | string | The project theme | No |
| channel | string | the project channel | No |
Example response
| Code Block |
|---|
{
"subscriptionId": "2f177274-514d-4be9-aa3d-4a550ab9e724",
"sessionId": "2f177274-514d-4be9-aa3d-4a550ab9e724",
"sessionTimeout": 1800
} |
Interacting with a session
...
Overview
Content Tools