API User

2024/12/04更新

    This section explains creation and management of users who need to accesss the API or SMTP interfaces.

    Adding an API user

    1.Click the Menu -> API settings at the top right of the management console.

    2.Click the add button on API user tab.

    3.Input the below items:

    Item

    Required

    Description

    API User

    Yes

    Input the ID for setting the API's api_user or SMTP authentication's username. Input in email format.

    API Key

    Yes

    Input the secret key for the API's api_key or SMTP authentication's password. Please input 8 or more characters using a combination of one or more alphanumeric characters.
    Passwords may include letters, numbers, and certain special characters. However, the following characters are not allowed: &, >, <, ", '.

    API Key (confirmation)

    Yes

    Input the same value as the API key.
    Passwords may include letters, numbers, and certain special characters. However, the following characters are not allowed: &, >, <, ", '.

    Authorization (Permissions)

    Yes

    Select the authorization for the API user. The API group Admin can access all APIs including APIs that can change other API settings and edit data. Normal API users can access API data such as the Transactional Email API's bounces, deliveries, and can download data references but can not edit the data.

    Operation Authorization

    Yes

    Gives permission to the API user to view or download the data including email addresses.

    Access Authorization

    Yes

    Gives permission to the API user to access HTTP-API and SMTP data. If you check the 'Access only own data', the Transactional Email API's bounces, deliveries, statistics and unsubscribes will be filtered to the scope of that user for the emails they sent. *You can not apply this restriction to the block list (subscription cancellation).
    The API group Admin can not check 'Access only own data'.

    Time Zone

    Yes

    This specifies the time zone used by the API user. The time zone is applied to HTTP-API request parameters and response data.

    4.API users will be added when you click the Save button.

    5.If you create an API user with the SMTP box checked, please reflect settings on your mail server.

    Editing the API user

    1.Click the API user, an edit dialog will appear.

    2.To finalize changes click the save button. (All fields you can fill out are editable.)

    Changing the API key

    1. To change the API key check the Change API key box to enable input for a new API key. Input the new API key and click the Save button to change the API key.

    2. If you create an API user with the SMTP box checked, please reflect settings on your mail server.

    Changing user access permissions

    1. To restrict access to either HTTP-API or SMTP data uncheck their corresponding checkboxes.

    2. If you create an API user with the SMTP box checked, please reflect settings on your mail server.

    Locking API users

    • If Lock this account is checked HTTP-API and SMTP access will be locked out.

    • If you create an API user with the SMTP box checked, please reflect settings on your mail server.

    Deleting API users

    1. Click the Delete button on the API user list. Input the password for the user and click the Delete button again to finalize the deletion.

    2. If you create an API user with the SMTP box checked, please reflect settings on your mail server.

    サポート一覧へ戻る

    Download

    変革を、ここから始める