Versions Compared

Version Old Version 13 New Version 14
Changes made by

Ylva Andersson

Josefin Klang (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
This article includes updates for Smart ID 23.04.2.

Example: /api/accessory


Excerpt


Example

Get order info:

:

/api/order/{orderId}

Expand
titleCard Production: Nexus GO Cards get info

Description

Use this task to perform "GET requests" towards the Nexus GO Cards ordering API and extract any attributes from the response.

Configuration

To use this task, configure the following delegate expression in your service task:

Code Block
${caasRestClientAction}

The parameters in the examples below can be configured in Identity Manager Admin.

Note
titleNexus GO Cards Ordering API

All the attributes that you want to extract have to match the Nexus GO Cards schema exactly. See Nexus GO Cards ordering for more information.


Note
titleImportant details
  • All parameters that are included in the URL, for example {cardId}, {orderId}, {email}, must be defined with the prefix "param_" since some of these values are also returned in the server response. This variable will not be written to the process map.
  • All query parameters that you want to define must be prefixed with "queryParam_". If not defined, the default will be used. This variable will not be written to the process map.
title
Expand
ParameterMandatoryValueDescription
URL
Image Removed

(tick) 

/api/order/{orderId}

The endpoint to call.

param_orderId
Image Removed

(tick) 

(for this endpoint)

Example value:

  • OD123

Will replace the {orderId} value from the URL.

costCentre-

Example value:

  • costCentre_Output
Will add the variable with the name costCentre_Output to the process map. The value will be taken from the response body.
orderer.email-

Example value:

  • ordererEmail_Output
Will add the variable with the name ordererEmail_Output to the process map. The value will be taken from the response body.
cardIds-

Example value:

  • cardIds_Output

Will add the variable with the name cardIds_Output to the process map as a list. The value will be taken from the response body.

accessories.articleId-

Example value:

  • accessories_articleIds_Output

Will add the variable with the name accessories_articleIds_Output to the process map as a list. The value will be taken from the response body.


Get available accessories:

expand

title
ParameterMandatoryValueDescription
URL
Image Removed

(tick) 

/api/accessoryThe endpoint to call.
queryParam_showDetails-Valid values:
  • true (default)
  • false
You can override the default query parameters by setting them yourself, or keep the default.
queryParam_languageId-Valid values:
  • DE
  • EN (default)
  • FR
  • SV
You can override the default query parameters by setting them yourself, or keep the default.
articleId-

Example value:

  • articleId_Output
Will add the variable with the name articleId_Output to the process map as a list. The value will be taken from the response body.
price-

Example value:

  • price_Output
Will add the variable with the name price to the process map as a list. The value will be taken from the response body.


Error cases

There are three major error cases:

  • Wrong URL
  • Mandatory parameter not defined, for example {cardId}
  • Resource not found, for example {cardId} does not exist

For these three error cases you will find two variables in the process map that describe what happened:

  • HTTP_STATUS_CODE
  • requestErrorMessage

You can use these variables to adjust your process flow accordingly.


Expand
titleCard Production: Server Side Card Operation

Description

Use this task to execute card productions on the server side. The service tasks supports execution of encodings via Card SDK or the JPKIEncoder integrated in Identity Manager. Printing is currently not supported.

Configuration

To use this task, configure the following delegate expression in your service task:

Code Block
${serverSideCardOperationTask}

The following parameters can be configured in Identity Manager Admin:

ParameterMandatoryValueDescription
encodingName

Image Removed(tick) 

Example value:

PcmEncProduceEmployeeCard

Name of the encoding description to be executed
cardSDK-

Valid values:

  • true (default)
  • false
Flag to configure if the encoding should be executed through the Identity Manager server directly or through Card SDK. Default is true, which means that the encoding is executed through Card SDK.



...