Scalebaseのデータを外部システムと連携するためのAPIについて、発行・認証からエンドポイント、変更ポリシー、代表的なレスポンスまでを、このページにまとめて説明します。
概要
Scalebase APIは、さまざまな外部システムとScalebaseを連携するためのWebサービスAPIです。
- Scalebaseでは、画面上の操作やファイルアップロードによる操作に加えて、APIを利用してデータを操作できます。
- Scalebaseのような顧客・契約・請求の管理基盤では、次のようなケースで外部の提供サービスとの接続が求められます。
- Scalebaseの画面を介さずに、提供サービスからの直接入力で顧客や契約を作成したい場合
- 例）自社のCRMツールで商談フェーズが受注済みになった際に、Scalebaseへ顧客と契約を登録する
- 提供サービスから、Scalebase内の顧客・契約・請求を参照し、提供サービスのユーザーに情報を開示したい場合
- 例）Scalebaseで請求が生成された際に、請求を取得してクレジットカード決済システムへ連携する
- 外部システムからScalebase APIを呼び出すことで、Scalebase側のデータを作成・取得・更新でき、よりシームレスなオペレーションを実現できます。契約の改定や使用量の更新もAPIで実行できます。
<aside>
💡
Scalebase APIは外部システム連携を目的とした公開APIであり、標準で請求書発行サービスと連携している内部APIとは異なります。
</aside>
APIでできること
APIでは、Scalebaseの画面上でできるほとんどの操作を行えます。
APIを通じてできる操作（例）
- 商品マスタ（カタログ）の閲覧
- 顧客の作成・閲覧・編集
- 契約の作成・閲覧・一部の編集
- 契約改定の実施
- 請求の閲覧
- 使用量データの登録
Scalebaseの画面ではできるが、現時点でAPIがサポートしない操作（例）