SuperSaaS APIの基本

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

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

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

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

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

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

APIの基本的な使い方

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

API Keyの取得方法

APIを利用するためには、認証としてAPI Keyが必要になります。

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

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

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

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

SuperSaaS

SuperSaaS. SuperSaaS has 10 repositories available. Follow their code on GitHub.

github.com

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

APIの使い方

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

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

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

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

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

Developer | Authentication

Authentication for all the 4 APIs. This tutorial will explain different authentication methods allowed for APIs.

www.supersaas.com