Blake Erickson
Mar 6, 2017 • 2 min read
本日、待望の公式APIドキュメントを公開することをお知らせします！
こちらからご覧いただけます：http://docs.discourse.org
今日これまで以上に、アプリケーションは他のアプリケーションと連携できる必要があります。Discourse APIを使用することで、Discourseフォーラムをあらゆるアプリケーションにかんたんに統合できます。RubyベースのAPIクライアントも提供していますが、お使いの会社やサーバーがRubyをサポートしていない場合でも、シンプルなHTTP RESTコールを通じて、任意のプログラミング言語で統合を実装するためにドキュメントをご利用いただけます。
Discourse APIとの統合を支援するために、PostmanアプリにインポートしてかんたんにAPI呼び出しを行えるPostmanファイルをご用意しています。Postmanは、APIリクエストを実行してHTTPステータスコードとレスポンスを確認できる優れたツールです。cURLのようなコマンドラインツールと比べて、より使いやすい場合があります。デモはこちらです：
APIで何ができますか？
何でもできます！DiscourseはJavaScriptアプリケーション（Railsバックエンド搭載）であり、私たち自身がAPIを利用しているため、Webアプリケーションで行えることはすべてAPI統合でも実現できます。
APIを使用して、新しいユーザーアカウントの作成、ユーザーの停止、ユーザーのログオフ、ユーザーへのロール割り当てなど、ユーザーに関するあらゆる側面を管理できます。
また、トピックの作成と返信、ユーザーに関する統計の収集、プライベートメッセージの送信、ファイルのアップロード、その他ほぼあらゆることが可能です。
DiscourseはWebhookもサポートしています！これは、新しいトピック、新しい投稿、新しいユーザーの作成などのイベントが発生するたびに、指定したエンドポイントにDiscourseがPOSTリクエストを送信することを意味します。つまり、特定のキーワードが誰かに言及されるたびに通知を受け取りたい場合、X分ごとにDiscourseをポーリングする必要はなく、代わりにWebhookイベントをリッスンするだけで済みます。アプリはトピックを解析し、APIを使用してDiscourse内でそのキーワードが使用されたことを通知するパーソナルメッセージを送信することができます。
コントリビューターを歓迎します
Discourse APIドキュメントはもちろんオープンソースですので、コントリビューションは大歓迎です。バグや未ドキュメントのエンドポイントなど、何か気になる点がございましたら、コントリビューション手順に従ってプルリクエストをお気軽にお送りください。
原文はこちら：
Good Loopでは、Discourseのセルフホスティングを安価で提供しています。開発元であるCDCK社の協力のもと、公式ブログ記事の翻訳・公開など、日本での普及にも努めています。