Reading time 3min

Kibi API

Automatically translated

Kibi REST APIは、外部アプリケーション、AIアシスタント、および自動化システムがKibi Connectのデータにアクセスできるようにします。APIを通じて、Wikiページ、ニュース記事、タスク、カレンダーのエントリなど、コンテンツの読み書きが可能です。

#APIアクセスを有効化

REST APIは、まずシステム管理者によって有効化される必要があります。設定は以下の場所にあります:

設定 → 統合 → REST API

ここで利用可能なオプションは以下の通りです:

  • REST APIを有効化

    APIインターフェースをオン/オフします。

  • トークン作成を特定のロールに制限

    有効化すると、選択されたロールを持つユーザーのみがAPIトークンを作成できます。個々のユーザーは、セキュリティタブのプロフィールの機能アクセスを通じて権限を付与することもできます。

  • IP制限を有効化

    有効化すると、指定されたIPアドレスのみがAPIにアクセスできます。これは追加のセキュリティ層です。

スクリーンショット:統合の下のAPI設定

#APIトークンを作成

各ユーザーは、自分のユーザープロフィールを通じて独自のAPIトークンを作成できます。次の場所に移動します:

ユーザープロフィール → 統合 → 新しいトークンを作成

トークンを作成する際に、以下を設定します:

  • 名前

    説明的な名前(例: "AIエージェント"、 "ERP統合"、 "ワークフロー自動化")。

  • 権限(スコープ)

    統合に実際に必要な権限のみを選択します(最小権限の原則)。

  • 有効期限(オプション)

    オプションで、トークンが自動的に無効になる期限を設定できます。

スクリーンショット:スコープ付きトークン作成フォーム

#トークンを安全に保管

作成後、トークンの値は1回のみ表示されます。すぐにコピーして、安全な場所(例:パスワードマネージャー)に保管してください。紛失した場合は、トークンを取り消して新しいものを作成する必要があります。

スクリーンショット:作成後のトークン - 1回のみ表示

#利用可能な権限(スコープ)

以下のスコープは、APIトークンのさまざまな領域へのアクセスを制御します:

スコープ

説明

posts:read

公開された投稿とニュースを読み取る

posts:write

投稿を作成、更新、削除する

wiki:read

Wikiページとドキュメントを読み取る

wiki:write

Wikiページを作成および更新する

calendar:read

カレンダーのエントリを読み取る

calendar:write

カレンダーのエントリを作成、更新、削除する

groups:read

公開グループ、メンバー、投稿、ファイルを読み取る

surveys:read

アンケートと結果を読み取る

tasks:read

タスクを読み取る(自分のタスクまたは割り当てられたタスクのみ)

tasks:write

タスクを作成および更新する

users:read

公開ユーザーディレクトリを読み取る(個人データは除く)

chat:read

会話とメッセージを読み取る

chat:write

メッセージを送信する(ボットおよび自動化用)

notifications:read

ユーザー通知を読み取る

notifications:write

ユーザーに通知を送信する(プッシュ通知を含む)

search

エンティティをまたぐ検索

#API認証

すべてのAPIリクエストは、AuthorizationヘッダーにBearerトークンとしてトークンを含める必要があります:

curl -H "Authorization: Bearer kbc_IhrTokenHier" \
     https://ihre-firma.kibi.de/api/v1/wiki

APIのベースURLは次のとおりです:https://ihre-firma.kibi.de/api/v1

#利用可能なエンドポイント

すべてのエンドポイントとパラメーターを含む完全なAPIドキュメントは、Kibi Connect内で直接利用できます:

  • インタラクティブなドキュメント:ユーザープロフィール → 統合 → APIドキュメント

  • OpenAPI仕様(JSON):ユーザープロフィール → 統合 → OpenAPI JSON

主なエンドポイントの概要:

領域

エンドポイント

説明

Wiki

GET /wiki

Wikiページを一覧表示

Wiki

POST /wiki

Wikiページを作成

ニュース

GET /posts

投稿を一覧表示

タスク

GET /tasks

タスクを一覧表示

カレンダー

GET /calendar/events

カレンダーのエントリを一覧表示

チャット

POST /chat/direct

ダイレクトメッセージを送信

ユーザー

GET /users

ユーザーディレクトリを一覧表示

検索

GET /search

エンティティをまたぐ全文検索

#トークンを管理

作成されたすべてのトークンは、ユーザープロフィール → 統合の概要に表示されます。ここで以下を確認できます:

  • トークンの名前

  • 割り当てられた権限

  • トークンが最後に使用された時刻

  • トークンを取り消すオプション

スクリーンショット:アクティブなトークンの概要

#重要な注意事項

  • データアクセス:APIトークンは、対応するユーザーがアクセスできるデータにのみアクセスできます。ユーザーの権限が引き続き適用されます。

  • セキュリティ:APIトークンを公開してはいけません。トークンは環境変数またはシークレットマネージャーに保存し、ソースコードには保存しないでください。

  • 最小権限:必要最小限の権限のみを付与してください。Wiki統合用のトークンには、チャットへのアクセスは必要ありません。

  • 有効期限:一時的な統合の場合は、セキュリティを向上させるために有効期限を設定してください。

  • 取り消し:不要になったトークンは、トークンの概要からすぐに取り消してください。