Bokskya is our cloud storage services for the end consumer. This API describes how to create and administrate user accounts and authorize reading devices and applications. Bokskya ID is the consumers unique ID. The ID is created using e-mail address as identifier.
These services should be integrated in your user registration process, so that you ensure that all your user accounts have a corresponding Bokskya account.
Validate account
Validate state for a Bokskya account by ddsId or email.
URL |
| ||
Method |
| ||
Request | Authorization | Required | The token acquired from the Authentication Service. Example: |
Date | Required | The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT | |
Accept | Required | application/json (We recommend all new implementations to use this header, XML support will be phased out in the future) | |
Response | {
"id": "212c60f9-57db-4b5b-b32a-ed561346eda1",
"active": true
}
| ||
Returns |
| OK (Will also be returned if user not found, see response body) | |
| On error | ||
Curl examples
Example of successful response based on email address:
curl -i -H "Accept: application/json" -H "Authorization: Boknett TGT-28905-pOzdvVr50wpTMl10DooFrDjTarMdwkeRzhlJ4KcMrQfEl13fxK-login.boknett.no" -H "Date: Thu, 13 Aug 2015 12:16:39 GMT" 'https://idp.dds.boknett.no/validate/ola.nordmann@norge.no'
HTTP/1.1 200 OK
Content-Length: 59
{"id":"212c60f9-57db-4b5b-b32a-ed561346eda1","active":true}
Example of request where user does not exist:
curl -i -H "Accept: application/json" -H "Authorization: Boknett TGT-28905-pOzdvVr50wpTMl10DooFrDjTarMdwkeRzhlJ4KcMrQfEl13fxK-login.boknett.no" -H "Date: Thu, 13 Aug 2015 12:16:39 GMT" 'https://idp.dds.boknett.no/validate/kari.nordmann@norge.no'HTTP/1.1 200 OKDate: Thu, 13 Aug 2015 12:24:30 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 25
{"data":"USER_NOT_FOUND"}
Register Account
Create a new DDS Bokskya user account
URL |
| ||
Method |
| ||
Request | Authorization | Required | The token acquired from the Authentication Service. Example: |
Date | Required | The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT | |
Accept | Required | application/json (We recommend all new implementations to use this header, XML support will be phased out in the future) | |
Content-type | Required | application/json | |
JSON attributes | Required | Email of the user (unique in bokskya) | |
name | Required | First name of the user (minimum length 2) | |
surname | Required | Surname of the user (minimum length 2) | |
Response | {
"id":"743a3b25-e71f-4544-82c7-b5e66358b08a",
"active":true
}
| ||
Returns |
| OK | |
| On error | ||
Curl example
Example of successful creation of user:
$curl -i -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Boknett TGT-29061-mbdeGwDnbGTJ4qlSv4IYTm5Cpu5iDO1XxOSgg2IPAXNPhGEa0v-login.boknett.no" -H "Date: Thu, 13 Aug 2015 14:40:00 GMT" -d '{"email":"ola.nordmann@norge.no","name":"Ola","surname":"Nordmann"}' "https://idp.dds.boknett.no/register"HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{"id":"743a3b25-e71f-4544-82c7-b5e66358b08a","active":true}
Auth user by partner
Service to authenticate a Bokskya account on behalf of a user and to support Bokskya implementation of Adobe Content Server VendorID.
URL |
| ||
Method |
| ||
Request | Authorization | Required | The token acquired from the Authentication Service. Example: |
Date | Required | The timestamp the request was made. Must comply with RFC 1123 date formats. Example: | |
Accept | Required | application/json (We recommend all new implementations to use this header, XML support will be phased out in the future) | |
Response | {"id":"QVFJQzV3TTJMWTRTZmN3clFvSjlsdzNuRkEzOXBwZjhYOEtBZEl4bWQ0bGRIVUkuKkFBSlRTUUFDTURFLio="}
Note: id attribute is base64 encoded token for authenticated {ddsId} (AQIC5wM2LY4SfcwrQoJ9lw3nFA39ppf8X8KAdIxmd4ldHUI. | ||
Returns |
| OK | |
| On errors | ||
Get adobeId
Look up AdobeID for a Bokskya account by ddsId or email
URL |
| ||
Method |
| ||
Request | Authorization | Required | The token acquired from the Authentication Service. Example: |
Date | Required | The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT | |
Accept | Required | application/json (We recommend all new implementations to use this header, XML support will be phased out in the future) | |
Response | When request is valid, user found and adobeId exist:
When request is valid, user found and adobeId not exist
| ||
Returns |
| OK | |
| On error | ||