連携・API
API で Apus をサードパーティシステムに接続する
Apus は REST API と webhook を提供しており、外部システムと双方向でデータを同期できます。本記事では、認証、2つの連携パターン、そしてベストプラクティスを扱います。
API キーを取得する
- 管理 → API・連携へ移動します。
- API クライアントを作成し、必要なモジュールにスコープを絞ります。
- クライアントシークレットを安全に保管します ― 一度しか表示されません。
- そのシークレットを使い、呼び出しごとにアクセストークンを取得します。
データを取得する(REST)
REST エンドポイントを呼び出して、請求書、製品、取引先などのレコードを読み書きします。各リクエストはクライアントの権限にスコープされるため、連携はそのロールが許可する範囲しか参照しません。
イベントを送信する(webhook)
webhook URL を登録すると、イベント(請求書の計上、受注の作成など)が発生した瞬間に、ポーリングせずに受け取れます。Apus は各ペイロードに署名するため、自社テナントから送られたものであることを検証できます。
ベストプラクティス
連携ごとに最小権限のスコープを使い、シークレットを定期的にローテーションし、webhook の署名を検証します。すべての API クライアントのアクティビティは監査ログで確認できます。
ヒント
外部システムごとに1つの API クライアントを作成すると、他に影響を与えずにアクセスを失効・ローテーションできます。
この記事は役に立ちましたか?