r1
| 1 | [[분류:알파위키의 기능]][[분류:the seed(위키 엔진)]][[분류:알파위키의 도움말]] |
|---|
| 2 | [include(틀:알파위키)] |
|---|
| 3 | [목차] |
|---|
| 4 | [clearfix] |
|---|
| 5 | == 개요 == |
|---|
r11
| 6 | the seed에 대한 자동 편집 툴과 같은 봇을 만들때 참고하실 수 있는 가이드입니다. 이 가이드는 기본적으로 [[https://doc.theseed.io|공식 문서]]를 기반으로 작성되었습니다. |
|---|
r6
| 7 | == 기본 구성 == |
|---|
r3
| 8 | the seed의 공개 API를 이용하는 경우 다음과 같이 작동합니다. |
|---|
| 9 | |
|---|
| 10 | 1. 공개 API의 엔드포인트로 접속하여 발급된 API 토큰을 통해 인증 |
|---|
r5
| 11 | 1. 해당 API 토큰의 사용자가 api_accecs 권한이 있는지 확인 |
|---|
| 12 | 1. 권한이 있다면 해당 엔드포인트에 알맞은 값을 반환 |
|---|
| 13 | 1. 권한이 없다면 403 Forbidden 반환 |
|---|
| 14 | |
|---|
r6
| 15 | 위와 같은 과정을 통해 역링크 목록, 문서 편집 및 이동, 삭제, 토론 목록 열람 등이 가능한 것이며, 그 외의 경고 해제, 자동 차단과 같은 봇은 selenium과 같은 라이브러리를 활용하여 개발된 the seed와 상관 없는 프로그램입니다. |
|---|
r12
| 16 | |
|---|
r6
| 17 | == API 유형 == |
|---|
| 18 | the seed에 존재하는 API는 다음과 같습니다. |
|---|
| 19 | |
|---|
| 20 | * 편집 API[*편집경로 (위키주소)/api/edit/(문서명)] |
|---|
| 21 | * 역링크 조회 API[*역링크경로 (위키주소)/api/backlink/문서명)] |
|---|
r7
| 22 | * 토론 목록 조회 api[*토론경로 (위키주소)/api/edit/(문서명)] |
|---|
r12
| 23 | |
|---|
r7
| 24 | == API 사용 == |
|---|
r10
| 25 | === bash === |
|---|
| 26 | 일반적인 curl과 같은 형식으로 api를 활용하는 법을 다룹니다. |
|---|
r7
| 27 | === 기본 === |
|---|
r8
| 28 | {{{#!syntax powershell |
|---|
r7
| 29 | curl https://alphawiki.org/api/edit/%EC%82%AC%EC%9A%A9%EC%9E%90:UTAU |
|---|
| 30 | -H "Authorization: Bearer ${UR_API_TOKEN}" |
|---|
| 31 | }}} |
|---|
| 32 | |
|---|
r9
| 33 | 위와 같이 모든 api는 인증이 필요합니다. UR_API_TOKEN은 이용자분의 API 토큰을 기입하시면 됩니다. |
|---|
r12
| 34 | |
|---|
r9
| 35 | ==== 편집 ==== |
|---|
| 36 | ==== 역링크 ==== |
|---|
r10
| 37 | ==== 토론 목록 조회 ==== |
|---|
r12
| 38 | |
|---|
| 39 | === HTTP 리퀘스트 === |
|---|
r10
| 40 | HTTP 리퀘스트를 통해 api를 활용하는 방법을 다룹니다. |
|---|
r12
| 41 | |
|---|
r10
| 42 | === 주의 사항 === |
|---|
| 43 | |
|---|