Skip to end of metadata
Go to start of metadata

Tokens list

Return a list of all tokens for the current vendor.

HTTP Method / URL

GET /core/v2/rest/token

Security

Basic Authentication

Request Header

Accept: application/json | application/xml

Request Parameters

- None -

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
403 - Access is denied
404 - Resource not found
500 - Internal service error

See also JavaDoc: TokenService.list

 Example
Request
Response
Try it now

 

Get token

Return a token by tokenNumber.

HTTP Method / URL

GET /core/v2/rest/token/{tokenNumber}

Security

Basic Authentication

Request Header

Accept: application/json | application/xml

Request Parameters

tokenNumber (string) - Token number.

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
403 - Access is denied
404 - Resource not found
500 - Internal service error

See also JavaDoc: TokenService.get

 Example
Request
Response
Try it now

 

Create token

Create token by tokenType and additional token parameters.

HTTP Method / URL

POST /core/v2/rest/token

Security

Basic Authentication
API Key Identification

Request Header

Accept: application/json | application/xml
Content-Type: application/x-www-form-urlencoded

Request Parameters

tokenType (enum) - Token type to be generated
- DEFAULT - default one-time token (will be expired after first request)
- SHOP       - shop token is used to redirect customer to the netlicensingShop
                   (licenseeNumber is mandatory)

- APIKEY - APIKey-token


licenseeNumber (string) - Only for tokenType=SHOP; identifies licensee that will be assigned to the shop token.

successURL (URI) - Take customers to this URL when they finish checkout.

successURLTitle (string) - Shop link title for successful checkout process.

cancelURL (URI) - Take customers to this URL when they cancel their checkout.

cancelURLTitle (string) - Shop link title for cancel checkout process.

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
403 - Access is denied
404 - Resource not found
500 - Internal service error

See also JavaDoc: TokenService.create

 Example
Request
Response
Try it now

Delete token

Delete a token by number.

HTTP Method / URL

DELETE /core/v2/rest/token/{tokenNumber}

Security

Basic Authentication

Request Header

Accept: application/json | application/xml

Request Parameters

tokenNumber (string) - Token number.

HTTP Status Code

204 - Successful request
400 - Malformed or illegal request
403 - Access is denied
404 - Resource not found
500 - Internal service error

See also JavaDoc: TokenService.delete

 Example
Request
Response
Try it now