本頁では、Scalebaseと外部システムと連携するためのAPIの利用方法や仕様について、説明いたします。

1．Scalebase APIの概要

• Scalebaseでは、画面上やファイルアップロードによる各種情報に対する操作のほか、APIを利用して操作する方法がございます。
• Scalebase APIは、様々な外部システムとの連携を目的としたWebサービスのAPIです。
  • 標準で請求書発行サービス連携している内部APIとは異なります。
• Scalebaseのような顧客・契約・請求の管理基盤では、以下のようなケースにおいて、しばしば提供サービスとの接続が求められることがあります。
  • Scalebaseの画面を介することなく、顧客や契約をScalebaseに作成する等のデータ作成の操作を、提供サービスからの直接入力により行いたい場合
    • 例）自社のCRMツールで商談のフェーズが受注済みになった際、Scalebaseに顧客と契約を登録
  • 提供サービスから、Scalebase内の顧客・契約・請求を参照して、提供サービスのユーザーに情報を開示したい場合
    • 例）Scalebaseで請求が生成された際、請求を取得してクレジットカード決済システムに請求を連携
• 外部システムからScalebase APIを呼び出す実装をすることで、Scalebase側のデータを作成・取得・更新することが可能となり、よりシームレスなオペレーションを実現することができます。
  • 契約に改定を加える操作や使用量を更新する操作もAPIで実行することができます。

2．APIでできること

• APIでは、Scalebase画面上からできるほとんどの操作を行うことができます。

APIを通じて可能な操作（例）

• 商品マスタ(カタログ)の閲覧
• 顧客の作成・閲覧・編集
• 契約の作成・閲覧・一部の編集
• 契約改定の実施
• 請求の閲覧
• 使用量データの登録
• Scalebase APIで実現できる内容の詳細は下記リファレンスをご覧ください。

Scalebase API