How to register API User

Summary

In this article, we will explain how to register an API user when connecting to TradeWaltz via API.

Table of Contents

1．About API User

2.  Preparations for Starting Registration

3.  How to Register API User

4.  Search for Registeted API User 

5.  Note

1. About API User

API users can be used to register, edit, and view the data via API Connection to TradeWaltz. API users set their user roles and their organaizations in the same way as TradeWaltz U/I users. Additionally, access permissions of the data which can be edited by API users will be controlled in the same ways as TradeWaltz U/I users. Please refer the contents below about the User Roles, Orgnaizations, Transaction Data Range Editable by Users.

• User Roles

• User Master

• Transaction Data Range Editable by Users

2. Preparantions for Starting Registration 

Before starting registration, please prepare the following items in advance. 

①　Master Setting and Sign in to TradeWaltz

Please set up the master so that you can use the TradeWaltz screen. 

* To register an API user, user must have at least one Company Admin role. 

* Once the User Master has been registered, please sign in to TradeWaltz from your web browser. 

②　Application of Fixed Global IP address 

Please use the helpdesk system to apply for a fixed global IP address to use when connecting API users. TradeWaltz will register provided gloabl IP address as whitlist. Only applied IP Address can connect TradeWaltz via API.

3. How to Register API User 

We explained registration steps of API user as below.

1. After sign in to TradeWaltz by Company Admin Role, click [Setting] from the side menu.

2. Click [+User New] button and you will be moved to the User Master screeen. Click [+ New] button on the top of the list.

3. User registration screen will be displayed. Click below items and click [Register] button.

＃	Item Name	Contents
1	User Type	Select [API User]
2	Validity	Select validity period. *Available only future time.Past time can not be selcted.  (You can register current time by click [Now] on the calender)
3	User Name/ User Name JP	Set your English name and Japanese name. （Not available for API）
4	Password	Set the password for API user sign in. ＊Password setting rule Number of characters： More than 9 but less than 32  Usable characters：Upper case letter, Lower case letter, Numbers, Symbols (!@#$%^&*) Combined condintion：Need to use more than 3 types of characters.
5	Language Setting	Set your language （Not available for API）
6	Organization Role	Selct Main or Sub organization. ＊Please selt one Main and the others as Sub if you belong to several organizations. ＊You can not slect only sub organization. Select organization for API user

４．Once registration is completed, [Completed] will be dsiplayed on the screen and move to the [User List] screen. You can use listed User ID when you connect API.

4．Search for Registerd API User

Registered API Users can be searched by [User Master]. Once you search the ID at [User List] screen, you can edit its ID by click [Edit] button.

5．Note

• TradeWaltz can not refer to the API user authentication informaiton (API user password). API user authentication information should be managed under the responsibility of the user company.