Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
Sharkey
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Dima Krasner
Sharkey
Commits
b9c5e95b
Commit
b9c5e95b
authored
4 years ago
by
syuilo
Browse files
Options
Downloads
Patches
Plain Diff
fix(docs): Update api doc
parent
0c1de7b1
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/docs/api.ja-JP.md
+8
-10
8 additions, 10 deletions
src/docs/api.ja-JP.md
with
8 additions
and
10 deletions
src/docs/api.ja-JP.md
+
8
−
10
View file @
b9c5e95b
...
...
@@ -8,20 +8,18 @@ APIを使い始めるには、まずアクセストークンを取得する必
## アクセストークンの取得
基本的に、APIはリクエストにはアクセストークンが必要となります。
あなたの作ろうとしているアプリケーションが、あなた専用のものなのか、それとも不特定多数の人に使ってもらうものなのかによって、アクセストークンの
取得手順は異なります。
APIにリクエストするのが自分自身なのか、不特定の利用者に使ってもらうアプリケーションなのかによって
取得手順は異なります。
*
あなた専用
の場合:
[
「自分
のアカウント
のアクセストークンを
取得
する」
](
#自分
のアカウント
のアクセストークンを
取得
する
)
に進む
*
皆に使ってもらう
場合:
[
「アプリケーション
として
アクセストークン
を取得
する」
](
#アプリケーション
として
アクセストークン
を取得
する
)
に進む
*
前者
の場合:
[
「自分
自身
のアクセストークンを
手動発行
する」
](
#自分
自身
のアクセストークンを
手動発行
する
)
に進む
*
後者の
場合:
[
「アプリケーション
利用者に
アクセストークン
の発行をリクエスト
する」
](
#アプリケーション
利用者に
アクセストークン
の発行をリクエスト
する
)
に進む
### 自分のアカウントのアクセストークンを取得する
「設定 > API」で、自分のアクセストークンを取得できます。
> この方法で入手したアクセストークンは強力なので、第三者に教えないでください(アプリなどにも入力しないでください)。
### 自分自身のアクセストークンを手動発行する
「設定 > API」で、自分のアクセストークンを発行できます。
[
「APIの使い方」へ進む
](
#APIの使い方
)
### アプリケーション
として
アクセストークン
を取得
する
アプリケーション
を使ってもらうには、ユーザーのアクセストークンを以下の手順で取得する必要があり
ます。
### アプリケーション
利用者に
アクセストークン
の発行をリクエスト
する
アプリケーション
利用者のアクセストークンを取得するには、以下の手順で発行をリクエストし
ます。
#### Step 1
...
...
@@ -48,7 +46,7 @@ UUIDを生成する。以後これをセッションIDと呼びます。
*
どのような権限があるかは
[
APIリファレンス
](
/api-doc
)
で確認できます
#### Step 3
ユーザーが
連携
を許可した後、
`{_URL_}/api/miauth/{session}/check`
にPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。
ユーザーが
発行
を許可した後、
`{_URL_}/api/miauth/{session}/check`
にPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。
レスポンスに含まれるプロパティ:
*
`token`
... ユーザーのアクセストークン
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment