Loomio API

Loomio APIを使用すると、Loomioを他のソフトウェアや自動化されたワークフローと連携できます。

OpenAPI 3.1仕様には、公開されているユーザーAPIとサーバーAPIのすべての操作が、機械で読み取れる形式で記述されています。APIクライアントにインポートしたり、型情報を持つクライアントコードの生成に使用したりできます。以下のガイドでは、この仕様だけでは十分に表現されていないワークフロー、権限、動作を説明します。

ユーザーAPI

ユーザーAPIは、Loomioユーザーとして操作を実行します。そのユーザーの権限に応じて、グループの一覧を取得したり、スレッド、コメント、アンケート、グループのメンバーシップを作成・管理したりできます。

プッシュ型の連携では、グループのWebhookが、選択されたLoomioのイベントをJSON形式でWebエンドポイントに送信します。Loomioのデータを読み取ったり変更したりするにはRESTエンドポイントを使用し、ポーリングせずにイベントを受信する連携にはWebhookを使用します。

サーバーAPI

サーバーAPIを使用すると、セルフホスト版Loomioの運用担当者がユーザーアカウントを管理できます。認証にはサーバー全体で共通のシークレットを使用します。