Manage access tokens

Get the Commerce API access token

Access tokens are essential credentials that allow an application to authenticate and access specific resources or APIs. They act as a key, providing a secure means to access server resources on behalf of the user. Use this resource to get the Commerce API access token.

GEThttps://api.digitalriver.com/oauth20/access-tokens

Response

200401

Successful response.

Body

application/json

sessionIdstring

Example: "your_session_ID"

userIdstring

Example: "your_user_ID"

externalReferenceIdstring

Example: "external_reference_ID"

authenticatedstring

Example: "true"

localestring

Example: "en_US"

currencystring

Example: "USD"

cartIdstring

Example: "your_cart_ID"

clientIpAddressstring

domainstring

Example: "drh-api-ot04.digitalriverws.net"

expiresIninteger

Example: 86397

themeIdstring

sessionTagstring

Example: "session_tag"

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/oauth20/access-tokens', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "sessionId": "your_session_ID",
  "userId": "your_user_ID",
  "externalReferenceId": "external_reference_ID",
  "authenticated": "true",
  "locale": "en_US",
  "currency": "USD",
  "cartId": "your_cart_ID",
  "clientIpAddress": "text",
  "domain": "drh-api-ot04.digitalriverws.net",
  "expiresIn": 86397,
  "themeId": "text",
  "sessionTag": "session_tag"
}

Delete the Commerce API access token

Use this resource to delete a Commerce API access token. You may want to delete an access token when:

• The token is no longer needed, for instance, after completing all required API calls.
• You wish to secure your application by periodically refreshing tokens, thus reducing the risk of token theft.
• Your application's user logs out, ensuring their session is completely terminated and cannot they cannot reuse it without re-authentication.

DELETEhttps://api.digitalriver.com/oauth20/access-tokens

Response

200401

Successful response.

Body

application/json

sessionIdstring

Example: "your_session_ID"

userIdstring

Example: "your_user_ID"

externalReferenceIdstring

Example: "external_reference_ID"

authenticatedstring

Example: "true"

localestring

Example: "en_US"

currencystring

Example: "USD"

cartIdstring

Example: "your_cart_ID"

clientIpAddressstring

domainstring

Example: "drh-api-ot04.digitalriverws.net"

expiresIninteger

Example: 86397

themeIdstring

sessionTagstring

Example: "session_tag"

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/oauth20/access-tokens', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "sessionId": "your_session_ID",
  "userId": "your_user_ID",
  "externalReferenceId": "external_reference_ID",
  "authenticated": "true",
  "locale": "en_US",
  "currency": "USD",
  "cartId": "your_cart_ID",
  "clientIpAddress": "text",
  "domain": "drh-api-ot04.digitalriverws.net",
  "expiresIn": 86397,
  "themeId": "text",
  "sessionTag": "session_tag"
}