REST API

REST APIとは

詳しくは公式コミュニティを確認してください。
簡単に説明すると、REST APIを使用することで外部からwikiのページの内容を取得したり編集したりすることができ、それによりページ更新の自動化などが実現します。

REST APIガイドライン

禁止事項

• 下記の行為、及びその他一般的に荒らしと認められる行為は禁止です
  これらの行為が確認された場合、該当のAPIを削除し運用者にも相応の対応をします

• 該当掲示板での同意なしに行う編集行為全て
• 短期間に大量の更新をするなどwikiに負担をかける行為
• 管理人の許可なしにAPIキーやシークレットを他人に教えたり、掲示板やその他外部サイト・SNSなどで公開する行為
• 投稿・編集ガイドラインに違反する行為
• 当ガイドラインに違反する行為

APIキーの新規発行手順

前提：APIを運用する人はzawazawaアカウントにログイン(持っていない場合は登録)してください

1. 概要掲示板に使用目的や運用方法を書き込み同意を得てください
2. 管理掲示板でAPIキーを新規発行して欲しい旨を書き込んでください
   ・このとき「アカウントと関連付けない」を有効にせずアカウントと関連付けてコメントすることが望ましいです
3. 管理人が確認した後、認められれば運用者は一般メンバーとして「API運用者」の役職が付きます
4. 「API運用掲示板」が閲覧できるようになるのでそこでAPIキーとシークレットを受け取ってください

• 1つの内容につき1つのAPIキーが原則で、APIキーを使い回すことはできません
  新しく他の内容でAPIを運用する場合は再度該当掲示板で同意を得た後に管理人に新規発行して貰ってください

運用にあたって

• できる限り維持費などのコストがかからず、かつ他の人でも再現できる方法で運用してください

• 「API運用者」の役職を付けられた後に掲示板でAPI関連のコメントをするときはアカウントと関連付けてコメントしてください
  ・運用者を識別するためにコテハンが望ましいです
  ・APIとは関係ないコメントについてはお好きなようにしていただいて結構です
• APIを使用して更新するページは全てこのページ(REST API/)の直下に作成してください
  (例) REST API/〇〇自動更新
• APIを使用して更新するページ直下に詳細ページを作成してください
  (例) REST API/〇〇自動更新/詳細
  詳細ページには下記の内容を記載してください
  ・親ページの簡単な説明
  ・APIを運用しているコードの詳細(GitHubなどで公開する場合はそこへのリンクを貼ってください)
  ・(既存の内容を置き換える場合のみ)何かあったときに復旧できるようにためにもともとあった内容のwikiコード