API
自社のアーカイブ を基盤に開発
REST APIは2種類です。ユーザーAPIは1人のユーザーとして、その人の権限どおりに動作します。システムAPIは組織として動作します。当社のアプリもこの2つのAPIで開発しており、日々の業務で使えることを確かめています。
User API
アプリから、1人分のアーカイブへ
利用者に代わって動作するアプリやAIアシスタント向けです。見えるのは、その人に見えるものだけです。
1人のユーザーとして動作
すべての呼び出しは、サインインした人の権限で実行されます。代理アクセス、プライベートドキュメント、部門アーカイブ、属性ごとの権限は、Webインターフェースと同じルールで確認されます。閲覧を許可されていないドキュメントは、アプリからは存在しないのと同じです。管理者アカウントは、そもそもサインインできません。
標準のOAuth 2.0を、正しく実装
アプリは認可コードフローとPKCEでサインインするため、デスクトップアプリやモバイルアプリにシークレットは不要です。OAuthライブラリにディスカバリー用のアドレスを1つ指定すれば、設定は自動で完了します。アクセストークンの有効期間は15分で、キーがリンクに含まれることはありません。
EMA Scan ClientもこのAPIで開発
当社のスキャンアプリは、御社が使うものとまったく同じユーザーAPIでサインインし、アーカイブしています。お客様のもとで毎日稼働しているアプリです。当社が実際の製品をこのAPIで作れるのですから、御社にも作れます。
EMA Scanを詳しく見る検索と閲覧
Webインターフェースと同じように検索し、保存した検索条件を使い、その人が閲覧できるすべてのドキュメントのテキストを読み取れます。
原本のダウンロード
アーカイブされたままの状態でドキュメントを取得したり、Message-IDでメールを探したりできます。
アプリからアーカイブ
ファイルのアップロードに加え、メッセージやスキャンデータを本人のアーカイブに取り込めます。
属性の読み取りと書き込み
請求書番号、プロジェクト、タグなどを、属性ごとに設定したルールに従って入力できます。
必要な権限だけ
アプリごとに、必要な権限だけを付与できます。検索と閲覧だけを許可したアプリは、ダウンロード、アーカイブ、変更を一切行えません。
利用者を指定
アプリを使える人を、特定のユーザーやディレクトリのグループに限定できます。サインインのたびに改めて確認されます。
ワンクリックで取り消し
アプリを無効にするか、そのトークンをすべて失効させれば、次の呼び出しからアクセスできなくなります。
すべて記録に
アプリの登録と属性の変更は、すべて監査ログに記録されます。必要に応じて、すべてのAPIリクエストも記録できます。
アプリ接続の流れ
アプリを
登録 管理者がEMAにアプリを追加し、権限と許可するリダイレクト先アドレスを選びます。
サインインは
1 回 利用者は、いつものEMAアカウントでサインインします。シングルサインオンを導入していれば、それも使えます。
本人
として 動作 アプリは、その人の権限どおりに検索、閲覧、アーカイブを行います。
いつでも
取り消し アプリを無効にするか権限を外せば、次の呼び出しから反映されます。
システムAPI
組織のバックエンド向け
データ移行、コンプライアンス業務のワークフロー、レポート、そしてアーカイブをほかのITシステムと連携させ続ける仕組みに使います。
有効にするまでオフ
検索から削除まで、機能ごとに専用のキーがあり、管理者がパスワードを設定するまで無効のままです。ある機能のキーで、ほかの機能は使えません。新しいパスワードを設定すると、古いパスワードはすぐに使えなくなります。
組織全体を対象に
システムAPIのキーは、個々のユーザーの権限を超えて、組織内のすべてのアーカイブに対して動作します。データ移行やコンプライアンスツールに必要なのはこの範囲です。だからこそキーはバックエンドに置き、ユーザーの前には出しません。人が使う場面には、ユーザーAPIがあります。
削除も、ルールに従って
1回の呼び出しで最大1,000件のドキュメントを削除できます。その場合もEMAは1件ずつ、最小保存期間の設定、リーガルホールド、WORMストレージ、進行中のケースと照合します。削除はすべて監査ログに記録されます。
検索とダウンロード
監査、法的手続き、社内の業務プロセスのために、アーカイブ全体からドキュメントを検索して取得できます。
メールとファイルのアーカイブ
APIで取り込んだメールも、通常のメールと同じ経路で処理されます。署名が付与され、インデックス化され、保存ルールが適用されます。ジャーナルレポートもそのまま取り込めます。
大量の属性も一括で
請求書番号、プロジェクト、ケースタグなどを、自社のシステムから数千件のドキュメントに設定できます。
代理アクセスとドメイン
代理アクセス、ローカルドメイン、アーカイブルールをディレクトリと同期させます。
レポートと分析
規模を問わず利用状況レポートを作成でき、多数の検索の件数を一度に集計できます。
通話録音
電話システムから、EMA Voiceによる録音の開始と停止を操作できます。
証明書
Webインターフェースを開かずに、自社のPKIから新しい証明書を展開できます。
安全なシャットダウン
停電時には、UPSからEMAを正しくシャットダウンできます。
ユーザーAPIか、システムAPIか
横にスワイプすると表の全体を見られます。
| 機能 |
User API
1人のユーザーとして
|
システムAPI
組織のために
|
|---|---|---|
| 対象 | ||
| 動作の主体 | サインインした1人のユーザー | 組織全体 |
| 見える範囲 | その人に閲覧が許可された範囲 | その機能の範囲内すべて |
| 主な用途 | アプリ、ポータル、AIアシスタント | データ移行、コンプライアンス、レポート |
| アクセス | ||
| サインイン | OAuth 2.0とPKCE | キーとパスワード |
| 有効化 | アプリ単位 | 機能単位 |
| 取り消し | ワンクリック | 新しいパスワード |
| できること | ||
| 検索と閲覧 | ||
| 原本のダウンロード | ||
| ファイルとメールのアーカイブ | ||
| 属性の読み取りと書き込み | ||
| ドキュメントの削除 | ||
| 代理アクセス、ドメイン、証明書 | ||
| レポートと分析 | ||
開発者の方へ
必要なものはすべて付属
APIドキュメント、SDK、サンプルはEMAに付属しています。ポータルへの登録は不要です。
.NET SDK
両方のAPIに対応した型付きクライアントです。サインイン、ページング、リトライ、証明書のピン留めを組み込んでいます。お使いのEMAからダウンロードできます。
EMAに内蔵のAPIドキュメント
すべてのエンドポイントを、curlとC#のリクエスト例付きで解説しています。Webインターフェースから直接開けます。
レート制限なし
連携の処理速度は、アーカイブの応答速度で決まります。
安定性を約束
メジャーバージョン内のアップデートでは、フィールドの削除、型の変更、必須パラメーターの追加を行いません。開発したものは、そのまま動き続けます。
保存前に自社で承認
Webhookを使えば、EMAが保存する前に、御社のサービスで属性の変更を承認、却下、修正できます。
インポート用のPowerShell
EMA Mail Import Toolsで、Microsoft 365、Exchange、IMAP、PSTなどからのインポートを、スクリプトで自由に実行できます。
ピン留めできる証明書
API呼び出しには、専用の証明書を持つポートを使います。アプリは、通信相手が自社のEMAであることを確認できます。
イベント通知は準備中
ドキュメントがアーカイブされた時点で動くスクリプトに、今後対応します。
APIに関するよくある質問
APIは無料ですか?
はい。APIにもSDKにも料金はかかりません。
どのEMAエディションで使えますか?
ユーザーAPIは、すべてのエディションに含まれます。システムAPIとSDKは、EMA Business Professional以上のすべてのエディションに含まれます。最小のエディションは小規模オフィス向けのコンパクトなアーカイブで、システムAPIとSDKは含まれません。
どのようなアプリを作れますか?
アーカイブ内を検索するもの、アーカイブに追加するものなら、何でも作れます。代表的な例は、利用者が自分のドキュメントを確認できるポータル、取り込みやスキャンのアプリ、送信した書類をアーカイブして属性を入力するERPやCRM、他システムからのデータ移行、コンプライアンスレポート、保存ルールに沿った削除ジョブ、AIアシスタントなどです。当社もEMA Scan ClientをユーザーAPIで開発しました。
ユーザーAPIとシステムAPIの違いは何ですか?
ユーザーAPIは、1人のユーザーとして動作します。アプリは利用者に代わってサインインし、EMAはすべての呼び出しにその人の権限を適用します。そのため、アプリに見えるのは本人に見える範囲までです。システムAPIは、組織のために動作します。データ移行、レポート、削除といったバックエンドの処理が、すべてのメールボックスを対象に実行されます。機能は1つずつ、それぞれのパスワードで有効にします。目安は簡単です。画面の前に人がいるならユーザーAPI、バックグラウンドで動く処理ならシステムAPIです。
アプリはどのようにサインインしますか?
ユーザーAPIのアプリは、OAuth 2.0でサインインします。管理者がアプリを登録し、各利用者は自分のEMAアカウントで一度サインインするだけです。アプリがパスワードを保存することはありません。システムAPIの呼び出しには、APIキーと機能ごとのパスワードを使います。アプリのアクセスを止めるには、管理者が登録を無効にするか、パスワードを変更します。どちらもすぐに反映されます。
システムAPIで削除しすぎることはありませんか?
削除されるのは、指定したドキュメントだけです。ドキュメントIDで指定し、1回の呼び出しで最大1,000件まで扱えます。「指定日より古いものをすべて削除」といったジョブはありません。最小保存期間の設定、リーガルホールド、削除ロック、WORMストレージは引き続き適用され、削除はすべて監査ログに記録されます。
APIドキュメント、サンプルコード、テストシステムはありますか?
はい。リクエスト例付きの完全なAPIリファレンスがEMAに付属しています。型付きクライアントを備えた.NET SDKが、サインイン、ページング、リトライを処理します。開発用のテストシステムが必要な場合は、手配できます。
アプリの開発を依頼できますか?
個別のアプリ開発は、当社では行っていません。開発は御社の開発者またはITパートナーが担当します。プロジェクトのご相談は喜んでお受けします。当社の開発者サポートが、御社のチームでもパートナーでも、コードを書く方を支援します。
新しいAPIを提案できますか?
ぜひお寄せください。必要な機能と用途をお知らせください。当社のロードマップに合えば追加します。
APIはEMA Cloudでも、オンプレミスのEMAでも使えますか?
はい。動作もまったく同じです。一方向けに書いたアプリは、変更なしでもう一方でも動きます。
EMAのアップデート後も、APIは安定して使えますか?
はい。メジャーバージョン内では、エラーコードの削除や名称変更、レスポンスフィールドの削除、フィールドの型の変更、任意パラメーターの必須化、これまで受け付けていた値の拒否は行いません。新しいフィールド、エンドポイント、任意パラメーターが追加されることはあるため、未知の項目を無視するコードはそのまま動き続けます。例外が必要になるのは、セキュリティ上の欠陥か重大なバグがある場合だけです。その場合も変更は最小限にとどめ、リリースノートでお知らせします。