Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

LogOnWithAccesKeyOptions is for generating a product specific accesskey for a user or for when a user changes language selection. It takes an accesskey and a json object . The json object contains a productGuid which is the guid for the product, a Boolean called UseVersionedMetadata for controlling the versioned metadata and a language id. This endpoint is for generating product and/or language specific access keys. An example usage of this could be setting metadata on a specific language rather than default English. with options.

URL : /ConnectService.js

Method : POST

Auth required : Yes

Required parameters

NameExampleDescription
methodLogOnAccessKeyOptionsFixed parameter that identifies the endpoint method.
accessKeyb77ca504-4335-4343-9109-11166a11ea0fValid access key from Digizuite
options

{
   "dez.

productGuid" : "AC045BF0-C538-4397-BC13-EF6A61DF6A82

configversionid" : "/0/0/0/",
   "dez.dataversionid" : "/0/0/0/",
   "dez.useversionedmetadata" : "0",
   "dez.setmembersystemlanguage": "3"
}

An JSON object

which contains dez.productGuid and dez.useversionedmetadata

with options for generating an accesskey. 

dez.configversionid (mandatory): This refers to the version ID of the channel which is logged on to. 

dez.dataversionid (mandatory): This refers to the version ID of the channel which data must be saved to and is used only for editing config data. It must be equal to the config version ID in all other contexts.

dez.useversionedmetadata (optional): This is a boolean referring to the use of versioned metadata. This is used for setting and retrieving config data so must be 1 in this context but 0 in all others. The parameter is optional when using this API method and defaults to 0.

dez.setmembersystemlanguage (optional):  This parameter changes the members language and gets an accesskey for this language in one go. It is used when a user changes language.



cUrl data example

Info
iconfalse

curl -X POST \
https://some.dam.com/dmm3bwsv3/ConnectService.js \
-H 'Cache-Control: no-cache' \
--data "method=LogOnAccessKeyOptions&accessKey=caf31b4b-4e43-45f7-a8aa-87cc490b6527&options={"dez.productGuid" : "AC045BF0-C538-4397-BC13-EF6A61DF6A82", "dez.useversionedmetadata" : "0", "dez.setmembersystemlanguage": "3"}"H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F method=LogOnAccessKeyOptions \
-F accesskey=24887db8-91af-44da-9470-9e14c4280d4e \
-F 'options={
"dez.configversionid" : "/0/0/0/",
"dez.dataversionid" : "/0/0/0/",
"dez.useversionedmetadata" : "0"
}'

Success Response

Code : 200 OK

...