SuperSaaS-FAN
〜 SuperSaaSの使い方 〜

Loading...

SuperSaaS APIの基本

SuperSaaSを独自設計システムで活用

APIを用いるとSuperSaaSを独自の仕組みで活用することができます。それこそ、SuperSaaSを内包した別のサービスとして展開することも可能です。

ただ残念ながら、現状のAPIは仕様的にも中途半端で十分な仕組み作りには不足も目立ちます。

それでも、アカウント内を横断して統計管理したり、独自の予約プロセスを構築したり、独自機能を付与した予約システムとして運用したりなど、工夫次第でいろいろと活用の幅が広がります。

SaaS活用の基本ですが、まず「できること」と「できないこと」を十分に理解するところから始めると設計や構想に無駄が出ません。

APIの基本理解は必須ですが、活用には公式のAPIモジュールライブラリを参考にしたり、改修して用いるなどが便利かもしれません。

APIの基本的な使い方

SuperSaaSのAPIはRESTfulです。
管理者の「アカウント名」と「API Key」をキーとして認証します。
単純にレスポンスを取得するものですので、およそクライアントを選ばずに利用できます。

API Keyの取得方法

APIを利用するための認証にアカウント名とAPI Keyが必須です。

もともとはアカウントパスワードをそのままAPI実行認証に用いていましたが、セキュリティ的な問題が指摘されたのかAPI Keyに置き換わりました。API Keyというよりは認証トークンと位置付けた方が理解しやすいかもしれません。
管理メニューのアカウント情報からAPI Keyを取得できます。
API Keyの発行

画面下部のAPI KeyにあるGenerateをクリックすることで発行されたAPI Keyが表示されます。

APIキーはパスワード同様に秘匿されるべき情報ですので、発行後は公開するをクリックしない限り表示されません。

「公開する」とあるので、まるで第三者にまで開示されるようにも見えますが、単に表示するという意味でしかありません。

API Keyはアカウントに対して一つだけです。複数発行して使い分けることはできません。
API Keyの再発行は実に簡単で、Roll Keyをクリックするだけです。現在のAPI Keyを無効にして、新たなAPI Keyが発行されます。

クライアント別モジュールライブラリ

いくつかのクライアントでAPIがモジュール化されてGitHubで公開されていますので、活用するクライアントが合えばそのまま便利に使えます。

なによりAPIを活用するメソッドの公式ソースと言えますので、独自の設計や開発の参考になります。

放置がひどいモジュールもありますが、コードが古くても十分参考になります。

APIの使い方

ライブラリを用いない場合、APIのコールとレスポンスの取得処理を独自に設計構築する必要があります。
それほど複雑なものではなく、RESTfulなのでごく単純で簡素に扱えます。

基本はAPIのURLに対して、HTTPメソッド(GET、PUT、POST、DELETE、OPTIONSなど)コールするだけです。

GETメソッドで用いることができるAPIであれば、普通にブラウザからURLを入力してホームページを閲覧するようにコールすることができます。

例:
https://www.supersaas.com/api/API名?account=アカウント名&api_key=API Key&フィールド=パラメータ&フィールド=パラメータ&…

例:認証情報はMD5ハッシュ化して代替できます
https://www.supersaas.com/api/API名?checksum=MD5ハッシュ化された認証情報&フィールド=パラメータ&

実際には任意のクライアントプラットフォームでAPIのコールとレスポンスの処理することになると思います。

APIを用いると、SuperSaaSの汎用機能にはない仕組みを構築できるので、活用幅が格段に広がります。
相応のディレクションスキルやプログラムスキルが必要となりますが、工夫次第で独自のユニークな仕組みの構築にチャレンジできます。

APIの利用上限に公式情報はありません。
とはいえ、無限のスケーリングとも思えませんので利用にはある程度の配慮が必要と思います。
そのため、上限制限の存在も踏まえて、プロシージャにウェイトやリミッターバッチを事前の設計仕様に入れておくべきかもしれません。