本文へスキップ
Sursa Developers

APIリファレンス

Sursaの公開API:35のセクションに222件のエンドポイントがあります。バージョン1.62.0。

APIキーで認証する連携システム向けの、Sursaの公開APIです。/v1の範囲の変更は追加のみです:新しい操作、省略可能なパラメーター、レスポンスのフィールド、レスポンスの列挙値が追加されることがあり、既存のクライアントはそのまま動作します。レスポンスに未知の列挙値があっても、有効な値として扱ってください。

ベースURL
https://api.sursa.com
認証
AuthorizationヘッダーでAPIキーを送信します:Authorization: Bearer <キー>。

セクション

health1件のエンドポイント

サービスの状態とバージョン

auth1件のエンドポイント

サインイン、セッション、「View as」モード(別のユーザーとして表示)、パスワードの変更とリセット、招待の承諾

users5件のエンドポイント

組織のユーザーアカウント

api-keys9件のエンドポイント

組織のAPIキー

apps8件のエンドポイント

組織のOAuthアプリと社員による認可

oauth3件のエンドポイント

OAuth 2.0プロトコル:同意画面、トークンの発行と取り消し、認可サーバーのメタデータ

audit4件のエンドポイント

組織の監査ログ

org1件のエンドポイント

組織、組織のロゴ、データのエクスポート

categories4件のエンドポイント

ドキュメントのカテゴリ

collections6件のエンドポイント

ナレッジのコレクション

cards26件のエンドポイント

ナレッジカード:アップロード、内容、表、バージョン、検証、コメント

jobs5件のエンドポイント

インデックス作成のキュー:ジョブ、解析プレビュー、変更ストリーム(SSE)

conversations2件のエンドポイント

アシスタントとの会話

answers3件のエンドポイント

検索とアシスタントの回答(SSEストリームを含む)

access-requests4件のエンドポイント

非表示の回答のソースへのアクセス申請

questions10件のエンドポイント

質問ログ、提案、回答のエクスポート、ライブ回答

files8件のエンドポイント

エクスポートファイル

insights1件のエンドポイント

インサイト:サマリー、重複、ナレッジギャップ、ナレッジの健全性

tasks1件のエンドポイント

ユーザーのタスクとチームのタスク

sources19件のエンドポイント

Google DriveやConfluenceなどのデータソース

permissions17件のエンドポイント

アクセス権の体系:権限の一覧(レジストリ)と、組織・コレクション・カード・ソースに対する権限(直接付与と継承の両方)

roles4件のエンドポイント

ロール:名前の付いた権限のセット(組み込みロールとカスタムロール)

groups7件のエンドポイント

ユーザーグループ:通常のグループ、「All members」(全メンバー)、ロールグループ、個人グループ

folders7件のエンドポイント

コレクションのフォルダー:最大3階層のツリー、同じ階層の要素を基準にした並べ替え、複数のフォルダーに入るカード、継承される権限

catalog6件のエンドポイント

外部サービス(SaaSとベンダー)のカタログ(名前、Webサイト、カテゴリ、アイコン、説明)と、組織で使う名前とカタログの項目とのリンク

drafts6件のエンドポイント

下書きと公開の承認

verification9件のエンドポイント

検証:状態、期限、検証者、履歴、「Verify first」キュー(先に検証すべきカード)、信頼度スコア(Trust Score)、オフボーディング

announcements5件のエンドポイント

必読のお知らせ:対象者、既読確認、レポート、リマインダー、エクスポート

comments4件のエンドポイント

カードのスレッド形式のコメント(アンカーと状態付き)とリアクション

webhooks17件のエンドポイント

組織のWebhook:Webhookの登録、イベントの購読、署名、配信と再試行

public-api1件のエンドポイント

連携システム向けの公開API:このAPIの機械可読な仕様

uploads5件のエンドポイント

大きなファイルのマルチパートアップロード:セッション、パート、検査付きの完了、カード・アーカイブファイル・インポートでの利用

analytics4件のエンドポイント

プロダクト分析:利用イベント、オブジェクトごとのカウンター、ダッシュボード(ナレッジの健全性・利用状況・貢献)、契約更新レポート、エクスポート

quality3件のエンドポイント

回答の品質:良い回答が得られなかった質問と、対応中のナレッジギャップ

finance6件のエンドポイント

財務ドキュメント:為替レートと取引先一覧

オブジェクト