開発者向けドキュメント

開発者向けドキュメント

ここに掲載されている内容は、開発者用の技術情報です。
掲載内容以上のサポートはできません。
ご利用にあたっては十分なご理解の上で活用ください。
SuperSaaSは開発中を含むwebhookとAPIを提供するもので、それを利用するサービス、アプリケーションに責任を持つことはできません。

SuperSaaSは独自のウェブアプリケーションやバックエンドシステムとの統合のための、Webhook、API (Application Programming Interfaces)を提供します。

Webhook

Webhookはユーザー定義のコールバックとして、他のアプリケーションやWebサイトにあなたのSuperSaaSアカウントで発生したイベントをほぼリアルタイムで通知します。
たとえば、新しいユーザーをメーリングリストに登録や変更された際に予定のチャットメッセージを送信するなど、スケジュールの機能を拡張するために使用できます。
他のメールサービスからメールを送信も参照可能です。

Webhookは、Zapier.commake.comなどのサービスを利用することでプログラミングを必要とせずに構成することができます。
サービスが提供する機能をカスタマイズすることで、SuperSaaSのWebhookを別のサーバに直接送信することもできます。
webhookに関してはこちらを参照ください。

API(Application Programming Interfaces)

SuperSaaSのデータベースに直接アクセスできるAPIを公開しています。

  1. ユーザーAPI
    ユーザーデータにアクセスするAPIです。
    ユーザーAPIでユーザー情報の取得や登録・更新・削除が可能です。
    ユーザー情報を登録とログインを同時に行うことメソッドも提供していますので、独自サイトでログインシステムを採用されている場合など、その情報を基にSuperSaaSへのユーザー登録やログインを連携するシームレスなシステム開発に活用できます。
  2. アポイントメントAPI
    予約データにアクセスするAPIです。
    予約データの取得や登録・更新が可能です。
    他にも特定のユーザーの予約検索や、スケジュール上で予約可能な情報の取得などメソッドも提供しています。
    開発中のAPIであり、それぞれのメソッドはすべてのスケジュールタイプに対応できておりません。
  3. フォームAPI
    フォームデータにアクセスするAPIです。
    フォームデータの取得が可能です
    ユーザーや予定などから紐付き検索でデータを取得するメソッドも提供しています。
  4. インフォメーションAPI
    データの構造などシステム情報にアクセスするAPIです。
    スケジュールのIDリストや、サービス・リソースリストなどが取得できます。

APIクライアントライブラリ

SuperSaaSのAPI活用を容易とするための各種プラットフォームの参考ライブラリです。
開発環境に合わせての参考利用にご活用ください。