Help Center

Menu

Asset Bank API

To build an integration flow that allows the Asset Bank component to interact with the Asset Bank API, complete the following steps.

  1. Create OAuth 2 credentials

  2. Apply the OAuth 2 credentials to the Asset Bank component

Create OAuth 2 credentials

(For Assetbank API OAuth2 details, see the Asset Bank API — OAuth2 documentation.)

To create OAuth 2 credentials, starting from the Squiz DXP Dashboard

  1. Click the Administration button.

  2. Click the System button in Manage your Squiz DXP organization.

  3. Click the API button.

  4. Click the Add new OAuth2 credentials button.

    The Add new OAuth2 credentials dialog presents.

  5. Fill in the Add new OAuth2 credentials dialog fields.

    Name

    Optional.

    Add a name to the credential. For management utility, choose a name that is distinct and meaningful.

    Description

    Optional.

    Add a description to the credential. Again, for ease of later management, a clear and distinct description is recommended.

    Client ID

    Required.

    This value is automatically generated.

    Clicking the Generate link manually creates a new 32-character hexadecimal string.

    Secret

    Required.

    This value is not automatically generated.

    Clicking the Generate link creates a 64-character hexadecimal string.

    Redirect URLS

    Required.

    Set this to \https://<your-tenant-address>/callback/auth2.

    Replace the placeholder string, <your-tenant-address>, with the integration platform domain name.

  6. Save the Client ID and Client Secret to an external file or location.

    These two strings are required in the Apply the OAuth 2 credentials to the Asset Bank component step.

    The Client Secret, in particular, is only displayed at this point and is not otherwise retrievable.

  7. Click the Save button.

Apply the OAuth 2 credentials to the Asset Bank component

Continuing through the Add new OAuth2 credentials dialog,

  1. Fill in the following fields to apply the new credentials to the component.

    Type

    Required.

    Select OAuth2 from the dropdown menu.

    Choose Auth Client

    Required.

    Select Add New Auth Client from the dropdown menu.

  2. Fill in the Add New Auth Client fields:

    Name

    Required.

    Add a name for the client. For management utility, choose a name that is distinct and meaningful.

    Client ID

    Required.

    Enter the Client ID saved from the previous steps.

    Client Secret

    Required.

    Enter the Client Secret saved from the previous steps.

    Authorization Endpoint

    Required.

    Set the OAuth 2 authorization endpoint to https://<your-assetbank-domain>/oauth/authorize.

    Replace the placeholder string, <your-assetbank-domain>, with the domain name of your Assetbank installation.

    Token endpoint

    Required.

    Set the refresh token endpoint to https://<your-assetbank-domain>/oauth/token.

    Replace the placeholder string, <your-assetbank-domain>, with the domain name of your Assetbank installation.

  3. Fill in the remaining Add new OAuth2 credentials fields

    Name your Credential

    Required.

    Add a name for the credential. For management utility, choose a name that is distinct and meaningful.

Server Name

Required.

Set the server name to the domain name of and path to your Asset bank installation. For example example.assetbank-server.com/assetbank-example.

Number of retries

Optional.

This sets the number of times the component should retry when making an API request.

If this is set, it must be set to a number.

Also, although this field is optional, it takes a default value of 5. If no number is entered here, the default value is used.

Delay between retries

Optional.

This sets the number of milliseconds (ms) between API request retries.

If this is set, it must be set to a number.

Also, although this field is optional, it takes a default value of 10000. If no number is entered here, the default value is used.