SuperSaaS-FAN
〜 SuperSaaSの使い方 〜

Loading...

SuperSaaSのAPIで独自の拡張活用が可能

APIを使ってもっと便利に独自のシステムを構築

SuperSaaSは汎用のオンライン予約システムとして簡単手軽に活用できる反面、その機能も汎用的なものとなっています。
それぞれの活用ニーズで独自の仕様の希望があっても、サービス全体としてそれに応えることは困難です。

そのためもあって、SuperSaaSはウェブフックやAPIが公開されており、任意の仕組みを独自に構築することができるようになっています。

以前の仕様は色々と懸念を覚えましたが、API Keyが実装されて比較的安全に使えるようになりました!

ウェブフックを用いる連携などのほうが簡単で手軽ではありますが、独自の予約システムや予約管理を行うには、やっぱりAPIを用いての自己構築が便利です。

もちろん、ある程度のウェブプログラム技術は必要になりますが、APIの利用なのでゼロベースからの構築でもなく、比較的容易にチャレンジできると思います。

APIを用いて独自の管理画面を設計

より便利な予約システムの構築や、活用しているビジネスプラットフォームへの組み込みなど活用幅が広がります。

APIの種類

APIは大きく分けて4種類あります。

アポイントAPI
予約情報(データベース)に直接アクセスできるAPIです。
予約情報の取得や、対象次第ですが作成・編集なども行えます。

定員制スケジュールは予約情報こそ対応していますが、スロット情報は副問い合わせ的な参照(SELECT)のみで、INSERT、UPDATE、DELETEはできません。
サービススケジュールは、予約情報の参照(SELECT)と削除(DELETE)のみ可能のようです。
予約に付随するフォームデータも副問い合わせ的な参照(SELECT)のみ可能です。
ユーザーAPI
ユーザー情報(データベース)に直接アクセスできるAPIです。
ユーザー情報の取得や作成・編集などが行えます。

こちらも、付随するフォームデータは副問い合わせ的な参照(SELECT)のみ可能です。
フォームAPI
フォーム情報(データベース)に直接アクセスできるAPIです。
フォーム情報を参照取得できます。

残念ながらフォーム情報は参照(SELECT)のみで編集(INSERT、UPDATE、DELETE)はできません。
インフォメーションAPI
データベース構造情報を取得できるAPIです。
たとえば、アカウント内のスケジュールやフォームのIDや名前、スケジュールのリソースやサービスのIDや名前、スケジュールで格納される情報の物理舞や論理名、型などが取得できます。
システム構築時のサポート的な位置づけのAPIと感じます。

公式ホームページにもあるように、APIは開発中の機能です。

APIはいまでこそデベロッパー用などと表に出ていますが、もともと裏メニューのような、良くも悪くも常連がわかっていて使っていた仕組みのようなもので

はなはだ中途半端なサービスですが、SQL生成実行のAPIだけに同系統はテーブルの向きを変える程度で構築できるはずですので、未実装はわざとかと思います。

利用負荷の経過観察中などかと思いますが、マネジメント的な問題で提供を制限している場合は、およそ永遠にこのまま開発中かもしれません。

API提供の拡充や基本機能の拡充を期待しながら活用しましょう!

APIを用いる注意点

書くまでもないですが、送信する情報は全てURLエンコードする必要があります。
誤動作の原因にもなりますのでうっかりには注意しましょう。

機械的な利用上限の実装などがないように見受けられますので、節度ある利用が求められているかもしれません。

ちなみに、リクエストヘッダにレスポンスキャッシュのIf-Modified-Sinceを用いることがSuperSaaS公式で推奨されています。

APIの活用には十分な設計と運用保守が求められているかもしれません。