外部システム連携について
概要
SmartDBでは、REST APIとWebhookを使用することで、外部システムと連携することができます。 外部システムからSmartDBに対して情報の取得や登録を行う場合や、SmartDBから外部システムに対して情報の取得や登録を行う場合は、REST APIを使用し、 SmartDBで発生したイベント(バインダへの文書登録やプロセスでのアクティビティ実施など)のタイミングで外部システムへ連携する場合は、Webhookを使用します。
連携の種類
外部システムからSmartDBの情報を取得・操作
外部システムからSmartDBの情報を取得・操作する場合は、REST APIを利用してください。 SmartDBのREST APIの使い方については、【SmartDBのREST API】を参照してください。
REST APIについては、【REST APIとは】を参照してください。
SmartDBから外部システムのデータを取得
バインダに文書を登録する際は、文書を更新する際に、外部システムのデータを取得したい場合には、外部API連携を利用してください。 外部API連携の使い方については、【外部API連携】を参照してください。
バインダの文書操作のイベントで外部システムへ連携
バインダに文書を登録した際や、文書を更新した際などのイベントのタイミングで、外部システムへ連携したい場合は、バインダのWebhook機能を利用してください。 バインダのWebhookの使い方については、【バインダのWebhook】を参照してください。
Webhookについては、【Webhookとは】を参照してください。
業務プロセス実施のイベントで外部システムへ連携
業務プロセスで承認済みとなった際のタイミングで、外部システムへ連携したい場合は、プロセスのWebhookを利用してください。 プロセスのWebhookの使い方については、【プロセスのWebhook】を参照してください。
Webhookについては、【Webhookとは】を参照してください。
制限事項
SmartDBでは、外部システムからのAPI呼び出し回数が、1秒あたり10回を超えると、制限がかかります。 制限を超えたリクエストには429エラーが返却されます。