Skip to content

Commit 56521e6

Browse files
committed
docs: updated docs
1 parent 3f3f518 commit 56521e6

File tree

3 files changed

+54
-3
lines changed

3 files changed

+54
-3
lines changed

β€Žcontent/ko/client-config/README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: μ• ν”Œλ¦¬μΌ€μ΄μ…˜ μ„€μ •ν•˜κΈ°
3+
description: Stella API에 λ“±λ‘λœ μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ„ μ„€μ •ν•©λ‹ˆλ‹€.
4+
position: 2
5+
category: λΉ λ₯Έμ‹œμž‘ κ°€μ΄λ“œ
6+
---
7+
Stella IT Accounts에 μžμ‹ μ˜ μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ„ λ“±λ‘ν–ˆλ‹€λ©΄, μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ„ μ„€μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
8+
μ•žμ—μ„œ λͺ…μ‹œν•œ 바와 같이, Stella IT λŠ” 자체 κ°œλ°œν•œ oAuth2 μ„œλ²„ [Meiling Gatekeeper](https://meili.ng) 에 κΈ°λ°˜ν•˜κ³  μžˆμŠ΅λ‹ˆλ‹€.
9+
10+
λ”°λΌμ„œ, λ³Έ λ¬Έμ„œμ— λ‚˜μ˜€λŠ” μš©μ–΄κ°€ μ΄ν•΄ν•˜κΈ° μ–΄λ ΅λ‹€λ©΄, [oAuth2 λ¬Έμ„œ (μ˜μ–΄)](https://oauth.net/2/) λ˜λŠ” [Googleμ—μ„œ μ œκ³΅ν•˜λŠ” oAuth2 연동 λ¬Έμ„œ](https://developers.google.com/identity/protocols/oauth2) ([μ˜μ–΄](https://developers.google.com/identity/protocols/oauth2)) λ₯Ό μ°Έκ³ ν•˜μ‹œλ©΄ 도움이 λ©λ‹ˆλ‹€.
11+
12+
## μ• ν”Œλ¦¬μΌ€μ΄μ…˜ μ„€μ • νŽ˜μ΄μ§€λ‘œ λ“€μ–΄κ°€κΈ°
13+
본격적으둜 μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ— κ΄€λ ¨ν•œ 정보λ₯Ό μ„€μ •ν•˜κΈ° μœ„ν•΄μ„œλŠ” μ• ν”Œλ¦¬μΌ€μ΄μ…˜ μ„€μ • νŽ˜μ΄μ§€λ‘œ 접속해야 ν•©λ‹ˆλ‹€.
14+
접속 방법은 λ‹€μŒκ³Ό κ°™μŠ΅λ‹ˆλ‹€.
15+
16+
1. [Stella IT Accounts 개인 μ„€μ • νŽ˜μ΄μ§€](https://accounts.stella-it.com/settings) 에 μ ‘μ†ν•©λ‹ˆλ‹€.
17+
2. μžμ‹ μ˜ 계정을 μ„ νƒν•˜κ±°λ‚˜, 둜그인 ν•©λ‹ˆλ‹€.
18+
3. 쒌츑의 μ‚¬μ΄λ“œλ°” λ˜λŠ” (λͺ¨λ°”일) 햄버거 λ©”λ‰΄μ—μ„œ **인증된 μ•±** 을 μ„ νƒν•©λ‹ˆλ‹€.
19+
4. **λ‚˜μ˜ μ•±** 을 μ„ νƒν•©λ‹ˆλ‹€.
20+
5. μˆ˜μ •ν•  μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ„ μ„ νƒν•©λ‹ˆλ‹€.
21+
6. **μ•± 관리** λ₯Ό ν΄λ¦­ν•©λ‹ˆλ‹€.
22+
23+
## μ•± 관리 μΈν„°νŽ˜μ΄μŠ€ 도움말
24+
* **Client Secret**: μ„œλ²„λ“±μ—μ„œ, 이 ν΄λΌμ΄μ–ΈνŠΈ μ„œλ²„κ°€ μš”μ²­ν•¨μ„ Stella IT Accounts μ„œλ²„μ— 증λͺ…ν•˜κΈ° μœ„ν•œ μ‹œν¬λ¦Ώ κ°’μž…λ‹ˆλ‹€.
25+
κΈ°λ³Έ 값은 μ—†μœΌλ©°, μ—†λŠ” 경우, Client Secret 없이 Stella IT Accounts 에 인증 토큰 λ°œκΈ‰λ“±μ„ μš”μ²­ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
26+
27+
* **Redirect URI**: ν”νžˆ *"콜백 μ£Όμ†Œ"* λ‘œλ„ 뢈리며, Stella IT Accounts μ—μ„œ μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ„ 인증 ν•œ ν›„, 인증 μ½”λ“œ λ˜λŠ” 인증 토큰을 λ°˜ν™˜ν•  μœ„μΉ˜ μž…λ‹ˆλ‹€.
28+
Meiling Gatekeeper의 경우 λ‹€μŒ 특수 Redirect URI λ₯Ό μΆ”κ°€μ μœΌλ‘œ μ§€μ›ν•©λ‹ˆλ‹€:
29+
- `urn:ietf:wg:oauth:2.0:oob`: Authorization code λ₯Ό μ†μˆ˜ λΆ™μ—¬λ„£λŠ” μΈν„°νŽ˜μ΄μŠ€λ₯Ό μ œκ³΅ν•©λ‹ˆλ‹€.
30+
31+
* **μ• ν”Œλ¦¬μΌ€μ΄μ…˜ κΆŒν•œ** _(Scopes)_ : μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ΄ oAuth2 둜 인증토큰을 μš”μ²­μ„ ν• λ–„ μš”μ²­ν•  수 μžˆλŠ” κΆŒν•œ _(scope)_ 의 μ˜μ—­μ„ μ§€μ •ν•©λ‹ˆλ‹€.

β€Žcontent/ko/getting-started/README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,17 @@ Stella APIλŠ” Stella IT의 μ„œλΉ„μŠ€λ₯Ό κ°œλ°œμžλΆ„λ“€κ»˜μ„œ 직접 ν”„λ‘œκ·Έ
88

99
## 계정 생성
1010
Stella APIλ₯Ό μ΄μš©ν•˜κΈ° μœ„ν•΄μ„œλŠ”, Stella IT Accounts 계정 생성이 ν•„μš”ν•©λ‹ˆλ‹€.
11-
Stella ITλŠ” API 인증에 [Meiling Engine](https://github.com/meiling-gatekeeper/meiling) 기반의 oAuth2 기반 인증을 μ‚¬μš©ν•˜κΈ° λ•Œλ¬Έμ—, APIλ₯Ό μ΄μš©ν•˜κΈ° μœ„ν•΄ 계정 생성은 ν•„μˆ˜ μž…λ‹ˆλ‹€.
11+
Stella ITλŠ” API 인증에 [Meiling Engine](https://meili.ng) 기반의 oAuth2 기반 인증을 μ‚¬μš©ν•˜κΈ° λ•Œλ¬Έμ—, APIλ₯Ό μ΄μš©ν•˜κΈ° μœ„ν•΄ 계정 생성은 ν•„μˆ˜ μž…λ‹ˆλ‹€.
1212

1313
계정을 μƒμ„±ν•˜λ €λ©΄, [Stella IT Accounts](https://accounts.stella-it.com) 으둜 이동해 계정을 생성해 μ£Όμ„Έμš”.
1414

1515
## μ• ν”Œλ¦¬μΌ€μ΄μ…˜ 등둝
1616
μžμ‹ μ΄ κ°œλ°œν•œ ν”„λ‘œκ·Έλž¨μ—μ„œ APIλ₯Ό μ΄μš©ν•˜λ €λ©΄, oAuth2 μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ„ Stella IT Accounts에 등둝해야 ν•©λ‹ˆλ‹€.
1717

18-
~~[Stella IT Accounts MyApps νŽ˜μ΄μ§€](https://accounts.stella-it.com/myApps) 으둜 이동해 μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ„ 등둝해 μ£Όμ„Έμš”.~~
19-
ν˜„μž¬ μžλ™ 등둝이 μ§€μ›λ˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€. μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ„ μƒμ„±ν•˜λ €λ©΄, [[email protected]](mailto:[email protected]) 으둜 연락 μ£Όμ„Έμš”.
18+
1. [Stella IT Accounts λ‚΄ 계정 관리](https://accounts.stella-it.com/) 둜 μ΄λ™ν•©λ‹ˆλ‹€.
19+
2. λ‘œκ·ΈμΈμ„ μ§„ν–‰ λ‚˜κ±°λ‚˜, λΉ„λ°€λ²ˆν˜Έλ₯Ό μž…λ ₯ν•©λ‹ˆλ‹€.
20+
3. 쒌츑 μ‚¬μ΄λ“œλ°” λ˜λŠ” (λͺ¨λ°”일) 우츑 μƒλ‹¨μ˜ 햄버거 λ©”λ‰΄μ—μ„œ **인증된 μ•±** 을 μ„ νƒν•©λ‹ˆλ‹€.
21+
4. ν˜„μž¬ 인증된 μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ΄ 뜨면, **λ‚˜μ˜ μ•±**을 μ„ νƒν•©λ‹ˆλ‹€.
22+
5. **μΆ”κ°€** λ²„νŠΌμ„ 눌러 μƒˆλ‘œμš΄ μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ„ λ“±λ‘ν•©λ‹ˆλ‹€.
23+
6. μ• ν”Œλ¦¬μΌ€μ΄μ…˜ μΆ”κ°€ λΌλŠ” 창이 뜨면, μ• ν”Œλ¦¬μΌ€μ΄μ…˜ 이름, Public URL둜 μ˜¬λΌκ°€ μžˆλŠ” μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ˜ μ•„μ΄μ½˜ 이미지 URL, κ°œμΈμ •λ³΄ μ·¨κΈ‰λ°©μΉ¨ URL, μ΄μš©μ•½κ΄€ URL을 μž‘μ„±ν•˜κ³  계속을 λˆ„λ¦…λ‹ˆλ‹€.
2024

β€Žcontent/ko/scopes/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Stella API의 κΆŒν•œ
3+
description: Stella APIλ₯Ό 톡해 μ ‘κ·Όν•  수 μžˆλŠ” κΆŒν•œλ“€μ„ μ•Œμ•„λ΄…λ‹ˆλ‹€.
4+
position: 2
5+
category: λΉ λ₯Έμ‹œμž‘ κ°€μ΄λ“œ
6+
---
7+
λ³Έ Scope λŠ” μ• ν”Œλ¦¬μΌ€μ΄μ…˜ 듀이 μ΄μš©ν•  수 μžˆλŠ” κΆŒν•œλ“€μ„ μ§€μ •ν•©λ‹ˆλ‹€.
8+
9+
## μ΄μš©ν•  수 μžˆλŠ” κΆŒν•œλ“€
10+
- `address`: λ‚΄ 계정에 λ“±λ‘λœ μ£Όμ†Œλ₯Ό ν™•μΈν•©λ‹ˆλ‹€. (μ£Όμ†Œκ°€ μˆ˜μ§‘λ˜μ§€ μ•Šμ•˜λͺ¨λ―€λ‘œ, μ‹€μ œλ‘œλŠ” μ œκ³΅λ˜μ§€ μ•ŠμŒ)
11+
- `email`: λ‚΄ 이메일을 ν™•μΈν•©λ‹ˆλ‹€.
12+
- `name`: λ‚΄ 계정에 λ“±λ‘λœ 이름을 ν™•μΈν•©λ‹ˆλ‹€.
13+
- `openid`: `/userinfo` λ₯Ό μΏΌλ¦¬ν•˜κ±°λ‚˜, `id_token` 을 λ°œκΈ‰λ°›μ„ 수 있으며, λ‚΄ μ‚¬μš©μž 이름등 기본적인 ν”„λ‘œν•„ 정보λ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€. (ν•„μˆ˜)
14+
- `phone`: λ“±λ‘λœ νœ΄λŒ€μ „ν™”λ²ˆν˜Έλ₯Ό ν™•μΈν•©λ‹ˆλ‹€.
15+
- `profile`: λ‚΄ ν”„λ‘œν•„ 정보λ₯Ό μ‘°νšŒν•©λ‹ˆλ‹€.
16+
- `https://console.stella-api.dev`: Stella IT Console 에 κ΄€λ ¨λœ 정보λ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€.

0 commit comments

Comments
Β (0)