Request PIN Control access token by plasticId.

This operation is used to create the PIN control access token.

The successful response from this call returns an id, a pinURL for mobile device webview and pinFrameURL for an iframe in desktop browser flow. Id is valid for 30 seconds.

For mobile webview, device should be instructed to do a POST call to the pinURL with the content of the id in a form field named controlId.

For desktop browser flow, iframe should be opened to pinFrameURL with query parameter key, which needs to be agreed with Enfuce beforehand. After iframe has been loaded, browser should make a window.postMessage() call to the iframe. The message object should contain fields operation (with value view-pin or set-pin) and controlId.

POST

plastic

{plasticId}

curl --request POST \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/pincontrol/v2/plastic/{plasticId} \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": "VIEW_PIN"
}'

{
  "id": "<string>",
  "pinURL": "<string>",
  "pinFrameURL": "<string>"
}

Path Parameters

plasticId

string

required

The id of the plastic for which the PIN should be accessed

Query Parameters

auditUser

string

required

The audit user to log the request

Body

application/json

The related PIN control request data

The body is of type object.

Response

201

application/json

Successful creation of the access token

The response is of type object.

Overview Request PIN Control access token by plasticId (Deprecated)

curl --request POST \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/pincontrol/v2/plastic/{plasticId} \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": "VIEW_PIN"
}'

{
  "id": "<string>",
  "pinURL": "<string>",
  "pinFrameURL": "<string>"
}