Skip to main content

How to Issue API Keys on MyPage

On MyPage, you can issue API keys, as well as view and disable API keys that have been previously issued on MyPage.

Operations related to API keys on MyPage can be performed in the [Connection Information] section by scrolling down from [MyPage TOP]. You can directly access [MyPage TOP] through this link. Login is required to access MyPage.

Steps to Issue an API Key​

  1. Click the "Issue API key" button in the [Connection Information] section. The "Issue API key" window will appear as shown in the figure below.
  2. In the displayed window, set the expiration date, source IP address, and API key issuance feature as needed. For details, please see Additional Features and Restrictions.
  3. Click the [Issue] button, and the issued API key will be displayed in [API key]. You can still check it even after closing the "Issue API key" window.

Figure. Issue API Key window

Additional Features and Restrictions​

Expiration Date​

You can choose to specify the expiration date either by selecting a specific date or by setting a duration from the issuance date. The duration can be specified in hours or days. Selecting [Unlimited] will issue an API key without an expiration date.

Source IP Address​

You can specify restrictions on the source IP addresses that can use the issued API key. If left blank, the API key will have no IP address restrictions.

To specify a range of IP addresses, you can use CIDR notation.

Example: 203.0.113.0/24

To specify multiple IP addresses or ranges, separate them with spaces.

Example: 203.0.113.0/24 198.51.100.0/24

API Key Issuance Feature​

If you want to grant the API key issuance feature, check the [Issuable] checkbox in the [Issue API key] section.

Checking Issued API Keys​

API keys issued on MyPage are listed in [Connection Information]. You can view each API key by clicking [Show] in the [API key] column of the table. You can also check the settings for expiration dates and IP address restrictions in the [Restriction] column.

Turning on the "Show disabled API keys" toggle button displays API keys that were issued on MyPage and then disabled.

note
  • The presence or absence of the API key issuance feature cannot be confirmed.
  • API keys issued using the API Key Issuance API are not displayed in the list.
  • API keys that became invalid because their configured expiration date passed, without being manually disabled, are not displayed even when "Show disabled API keys" is turned on.

Steps to Disable an API Key​

API keys issued on MyPage can be manually disabled on MyPage.

  1. In [Connection Information], check the checkbox of the API key you want to disable and click the [Disable] button.
  2. A confirmation screen titled [Disable API key] will appear. After confirming that the API key is correct, click the [Disable] button.
  3. An authentication code will be sent to the email address registered to your account. Enter this code in the [Authentication Code Confirmation] screen displayed on MyPage and click the [Send] button.
  4. The API key will be disabled, and you will receive an email notifying you of the API key disablement at the email address registered to your account.
caution
  • There is a limit to the number of API keys that can be disabled. Each account can disable up to 20 API keys in total. The number of API keys disabled so far is displayed on the [Disable API key] screen shown in step 2 above.
  • Disabling an API key is intended for cases where there is a security risk, such as a suspected leak of the API key. If you want to periodically update API keys or temporarily suspend their use, use the Expiration Date setting instead of disabling them.
  • API keys that accounts created before the MyPage renewal on 2025/06/30 initially possess cannot be disabled. To disable them, you need to cancel your membership and create a new account.
  • API keys issued using the API Key Issuance API cannot be disabled.