Skip to main content

Create an API Secret Key (Merchant API)

Overview​

This section explains how to newly issue and create an API secret key with the Merchant API add-on feature.

Purpose​

The purpose is to issue and manage API Secret Keys for the Merchant API on an organization-wide basis, allowing for centralized management of authentication credentials used for integration with external core systems, logistics systems, and accounting software, separated by application.

By separating keys for each integration target, you can organize which system uses which authentication information and maintain visibility of operations and permissions.

Feature Description​

Merchant API and API Secret Key​

The Merchant API add-on is an API provision feature for integrating and utilizing DEXTRE data with external core systems, logistics systems, and accounting software.

A dedicated API secret key is required for data integration between DEXTRE and external applications (servers).

With this feature, you can issue and create DEXTRE API secret keys.

For details on available endpoints and authentication methods, please refer to the DEXTRE Merchant API Documentation.

Prerequisites for Use​

To use the Merchant API integration feature, you must subscribe to and activate the Merchant API add-on in advance.

For details regarding contracts, please refer to Subscribe to the Merchant API Add-on.

Instructions​

Moving to the API Secret Key Creation Screen​

  1. Click Maker Settings > Open Maker Settings.
  2. Click API.
  3. Click Create a New Key.
    The "Create A New API Secret Key" modal opens.

How to Enter the Form​

  1. Name (Required)
    Enter the name of the API secret key.

  2. Description (Optional)
    Enter the overview of the API secret key.

Create API Secret Key​

warning

The issued API secret key is displayed only once at the time of issuance.
It cannot be re-displayed on the system later.

  1. After confirming the input details, click the Create button.
    The API secret key is issued.

  2. Created API Secret Key
    Store the displayed API secret key in a secure location.

  3. I have saved the API secret key in a secure location.
    Check this box after you have stored the API secret key in a secure location.

  4. Click the Close button.

Important Notes​

Please Store the API Secret Key in a Secure Location​

The issued API secret key is displayed only once at the time of issuance.

Since it cannot be re-displayed on the system later, please be sure to store it in a secure location when creating it.

Operate API Secret Keys for Each Integration Target​

It is recommended to issue and use one API secret key for one integration target application (server).

Reusing one API secret key across multiple integration targets is not recommended.

Request Limits for Merchant API​

The Merchant API has the following request limits:

  • 300 requests / minute per merchant (manufacturer organization)

If the limit is exceeded, the request will fail and an error will be returned.

*Technically, 429 Too Many Requests is returned.