Skip to content

Commit 1aae76d

Browse files
committed
Update README
1 parent 134ffc8 commit 1aae76d

File tree

4 files changed

+26
-2
lines changed

4 files changed

+26
-2
lines changed

README.ja.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,19 @@ ViewCustomize = {
123123
}
124124
```
125125

126-
例えばユーザのAPIキーにアクセスするには`ViewCustomize.context.user.apiKey`となります。
126+
例えばユーザのAPIアクセスキーにアクセスするには`ViewCustomize.context.user.apiKey`となります。
127+
128+
### APIアクセスキー
129+
130+
APIアクセスキーは、個人設定画面のAPIアクセスキーの「表示」リンクを初めて押下したタイミングで生成されます。
131+
132+
![Screenshot of my account](screenshots/my_account.en.png)
133+
134+
自動的に生成したい場合には、プラグインの設定画面にて「APIアクセスキーを自動的に作成する」をONにしてください。各ユーザに個人設定画面で操作してもらわなくても、APIアクセスキーが生成されるようになります。
135+
136+
![Screenshot of plugin configure](screenshots/plugin_configure.en.png)
137+
138+
APIアクセスキーの利用には、設定画面の「API」タブにて、「RESTによるWebサービスを有効にする」をONにしておく必要があります。
127139

128140
## 設定例
129141

README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,19 @@ ViewCustomize = {
129129
}
130130
```
131131

132-
For example, to access the user's API key is `ViewCustomize.context.user.apiKey`.
132+
For example, to access the user's API access key is `ViewCustomize.context.user.apiKey`.
133+
134+
### API access key
135+
136+
The API access key is created when the "Show" link of the API access key on the My account page is click for the first time.
137+
138+
![Screenshot of my account](screenshots/my_account.en.png)
139+
140+
If you want to created it automatically, set "Automatically create API access key" to ON in the plugin configure page. API access keys can be created without having each user operate the My account page.
141+
142+
![Screenshot of plugin configure](screenshots/plugin_configure.en.png)
143+
144+
To use the API access key, "Enable REST web service" must be turned on in the "API" tab of the setting page.
133145

134146
## Examples
135147

screenshots/my_account.en.png

19.1 KB
Loading

screenshots/plugin_configure.en.png

6.19 KB
Loading

0 commit comments

Comments
 (0)