| r30 | ||
|---|---|---|
| r25 (r23으로 되돌림) | 1 | [[분류:the seed/권한]] |
| r17 (r14으로 되돌림) | 2 | [include(틀:the seed/권한)] |
| 3 | [목차] | |
| 4 | == 개요 == | |
| r26 | 5 | [[the seed]] 엔진에서 존재하는 권한 중 하나이다. |
| r16 (새 문서) | 6 | |
| r28 | 7 | == 용도 == |
| r30 | 8 | 더시드엔진은 공개 API를 통한 외부 접속 기능을 지원한다. 단, API는 계정 사용자에 한해서 지원되며 API로 접속하려면 계정의 로그인 정보 대신 API Token이라는 256자리의 무작위 숫자+알파벳으로 구성된 개인 식별키가 필요하다.[* API Token은 로그인 후 '우측 상단 프로필 메뉴>내 정보' 페이지에서 최하단에 있는 API Token 항목의 발급 버튼을 누르고 계정의 비밀번호를 입력해서 발급받을 수 있다. 참고로 한번 발급받은 API Token키는 반영구적으로 유지되지만, '''최초 발급 때를 제외하고 재확인할 방법이 아예 없어서 따로 저장을 해두어야 한다.''' 토큰값을 잊어버려서 재발급하려면 그냥 최초 발급이랑 똑같이 발급받으면 되는데 이 경우 기존 토큰은 만료되고 새 토큰값이 발급되는 식이다. 발급 횟수에는 딱히 제한이 없다.] 이를 이용해 웹브라우저가 아닌 봇, 터미널 프로그램등을 이용해 엔진에 직접 접근하여 자동 편집 등의 위키 작업이 가능하다. 이 때 API를 사용하기 위해서 필요한 권한이 바로 이 권한이다. |
| r16 (새 문서) | 9 | |
| r28 | 10 | 더시드엔진에서 API는 기본적으로 보호 처리가 되어 있어서 이 권한이 없으면 API Token이 있어도 엔진 상에서 API 접근이 차단된다.[* 이 권한이 없는 상태에서 API 접속 시도 시 어떤 작업을 하더라도 접근 권한이 없다는 '403(Forbidden)' 에러를 반환한다.] 따라서 API를 이용한 봇을 운용하려면 반드시 이 권한이 필요하다. |
| 11 | ||
| 12 | [[https://doc.theseed.io]]에서 API의 사용 방법을 확인할 수 있다. | |
| 13 | ||
| r27 | 14 | == API 사용 방법 == |
| r17 (r14으로 되돌림) | 15 | 1. 사용자가 요청하면 JSON으로 반환하게 된다. |
| r22 | 16 | 2. API_TOKEN[* 'Authorization': 'Bearer API_TOKEN'의 API_TOKEN[br] 이때, Bearer는 제거하면 안 된다.]에는 [[https://theseed.io/member/mypage|내 정보]]의 API Token[* 유출되지 않도록 유의해야한다.] 발급 버튼을 눌러 자신의 계정 비밀번호를 입력한 뒤 나오는 token값을 적으면 된다. |
| r17 (r14으로 되돌림) | 17 | |
| 18 | === python === | |
| 19 | ==== 편집 시작 ==== | |
| 20 | {{{#!syntax python | |
| 21 | import requests | |
| 22 | ||
| 23 | headers = { | |
| 24 | 'Authorization': 'Bearer API_TOKEN', | |
| 25 | } | |
| 26 | ||
| 27 | requests.get('https://theseed.io/api/edit/%EB%8D%94%EC%83%88%EB%93%9C%EC%9C%84%ED%82%A4', headers=headers) | |
| 28 | }}} | |
| r21 | 29 | |
| r17 (r14으로 되돌림) | 30 | ===== 결과 ===== |
| 31 | ||{ | |
| r21 | 32 | "text": "\ |
| 33 | ||
| 34 | [[분류:더새드위키]]\\n[include\(틀:더새드위키)]\\n|\|<-2><table align=right><:><bgcolor=#fedcba>''\'{{\{#black 더새드위키[br]The Sad Wiki}}}''\' |\|\\n|\|<:><bgcolor=#fedcba>''\'{{\{#black 개설 일자}}}''\' |\|<#FFFFFF> 2021년 1월 25일[\* \[[더새드위키:가짜규칙]] 문서가 처음 \\"차단회피\\"라는 문서명으로 생성되고 더새드위키:가짜규칙 문서명으로 이동된 날짜 기준] |\|\\n|\|<:><bgcolor=#fedcba>''\'{{\{#black 대표색}}}''\' |\|<#FFFFFF> {{\{#!wiki style=\\"display: inline; background: #fedcba; border-radius: 3px; padding: 3px 4px\\"\\n{{\{#000000 ''\'살구색''\' {{\{-2 (#fedcba)}}}}}}}}}[\* 알파위키의 대표색인 #abcdef를 거꾸로 한 것이다.] |\|\\n|\|<:><bgcolor=#fedcba>''\'{{\{#black 언어}}}''\' |\|<#FFFFFF> 한국어 |\|\\n|\|<:><bgcolor=#fedcba>''\'{{\{#black 위키 엔진}}}''\' |\|<#FFFFFF> the seed |\|\\n|\|<:><bgcolor=#fedcba>''\'{{\{#black 라이선스}}}''\' |\|<#FFFFFF> CC BY-SA 4.0 |\|\\n|\|<:><bgcolor=#fedcba>''\'{{\{#black 창립자}}}''\' |\|<#FFFFFF> \[[사용자:maca|maca]] |\|\\n|\|<:><bgcolor=#fedcba>''\'{{\{#black 소유자}}}''\' |\|<#FFFFFF> \[[사용자:maca|maca]] |\|\\n|\|<:><bgcolor=#fedcba>''\'{{\{#black 사무관}}}''\' |\|<#FFFFFF> \[[사용자:maca|maca]] |\|\\n|\|<:><bgcolor=#fedcba>''\'{{\{#black 상임 관리자}}}''\' |\|<#FFFFFF> \[[사용자:maca|maca]][\*+], \[[사용자:Blank|Blank]] |\|\\n|\|<:><bgcolor=#fedcba>''\'{{\{#black 운영관리관}}}''\' |\|<#FFFFFF> \[[사용자:maca|maca]], \[[사용자:Blank|Blank]] |\|\\n|\|<:><bgcolor=#fedcba>''\'{{\{#black 관리자}}}''\' |\|<#FFFFFF> \[[사용자:chodyyy|chodyyy]] |\|\\n\[목차]\\n= 개요 =\\n>우리 모두가 창조해 나가는 가상의 위키, 더새드위키\\n>-\--\-\\n>더새드위키의 슬로건\\n2021년 1월 25일 더시드위키에서 만들어진 더시드위키 내 가상의 위키이다. -\-더시드위키의 식민지다.-\- 실제로 있는 위키는 아니다.\\n\\n= 트리비아 =\\n * 번역하면 슬픈(sad) 위키라고 한다.\\n * 네이버에 더새드위키라고 검색하면 더샌드위치(...)로 나온다.\\n\[각주]", | |
| r17 (r14으로 되돌림) | 35 | "exists": true, |
| 36 | "token": "Gg1GLvxEks+V3rS30qa2oelNP2VNxrGWC2HLKtBmH21/xoWCHpEdRbZ5liNh7IWI" | |
| 37 | } | |
| 38 | || | |
| 39 | ||
| 40 | ==== 편집 제출 ==== | |
| 41 | * 이곳의 token에는 편집 시작에서 JSON으로 받은 token값을 입력하면 된다. | |
| 42 | {{{#!syntax python | |
| 43 | import requests | |
| 44 | import json | |
| 45 | ||
| 46 | headers = { | |
| 47 | 'Content-Type': 'application/json', | |
| 48 | 'Authorization': 'Bearer API_TOKEN', | |
| 49 | } | |
| 50 | ||
| 51 | data = { | |
| 52 | 'text': 'Hello, world', #수정할 내용 | |
| 53 | 'log': '', #자동 편집 시 남길 편집 요약 | |
| 54 | 'token': received_token #편집 시작 시 받은 token | |
| 55 | } | |
| 56 | ||
| 57 | response = requests.post('https://theseed.io/api/edit/%EB%8D%94%EC%83%88%EB%93%9C%EC%9C%84%ED%82%A4', headers=headers, data=json.dumps(data)) | |
| 58 | }}} | |
| r21 | 59 | |
| r17 (r14으로 되돌림) | 60 | ===== 결과 ===== |
| 61 | {{{#!syntax json | |
| 62 | { | |
| 63 | "status":"success", | |
| 64 | "rev":28 | |
| 65 | } | |
| 66 | }}} | |
| r21 | 67 | |
| r17 (r14으로 되돌림) | 68 | ==== 역링크 조회 ==== |
| 69 | {{{#!syntax python | |
| 70 | import requests | |
| 71 | ||
| 72 | headers = { | |
| 73 | 'Content-Type': 'application/json', | |
| 74 | 'Authorization': 'Bearer API_TOKEN', | |
| 75 | } | |
| 76 | ||
| 77 | response = requests.get('https://theseed.io/api/backlink/%EB%8D%94%EC%83%88%EB%93%9C%EC%9C%84%ED%82%A4', headers=headers) | |
| 78 | }}} | |
| r21 | 79 | |
| r17 (r14으로 되돌림) | 80 | ===== 결과 ===== |
| 81 | {{{#!syntax json | |
| 82 | { | |
| 83 | "namespaces":[ | |
| 84 | {"namespace":"문서","count":6}, | |
| 85 | {"namespace":"틀","count":5}, | |
| 86 | {"namespace":"분류","count":1} | |
| 87 | ], | |
| 88 | "backlinks":[ | |
| 89 | {"document":"Thesadwiki","flags":"redirect"}, | |
| 90 | {"document":"thesadwiki","flags":"redirect"}, | |
| 91 | {"document":"더새드위키:sad스킨","flags":"link"}, | |
| 92 | {"document":"더새드위키:권한 요청","flags":"link"}, | |
| 93 | {"document":"슬픈 위키","flags":"redirect"}, | |
| 94 | {"document":"위키 등급분류","flags":"link"} | |
| 95 | ], | |
| 96 | "from":null, | |
| 97 | "until":null | |
| 98 | } | |
| r25 (r23으로 되돌림) | 99 | }}} |
| 100 | ||
| 101 | ===== 토론 목록 조회 ===== | |
| 102 | {{{#!syntax python | |
| 103 | import requests | |
| 104 | headers = { | |
| 105 | 'Content-Type': 'application/json', | |
| 106 | 'Authorization': 'Bearer API_TOKEN', | |
| 107 | } | |
| 108 | response = requests.get('https://theseed.io/api/discuss/%EB%8D%94%EC%8B%9C%EB%93%9C%EC%9C%84%ED%82%A4:%EC%97%B0%EC%8A%B5%EC%9E%A5', headers=headers) | |
| 109 | }}} | |
| 110 | ||
| 111 | ====== 결과 ====== | |
| 112 | {{{#!syntax json | |
| 113 | [ | |
| 114 | { | |
| 115 | "slug": "GleamingSqualidRedPies", | |
| 116 | "topic": "더시드위키 토론 연습장", | |
| 117 | "updated_date": 1736493937, | |
| 118 | "status": "normal" | |
| 119 | } | |
| 120 | ] | |
| 121 | }}} |