HOME > 機能 > スパイラルAPIとは

スパイラルAPI




スパイラルAPIとは

スパイラルは登録データから一覧表・単票や集計表、グラフを作成、表示するWebパーツ機能を備えています。スパイラルAPIでは、各Webパーツ機能で設定したロジックを適用してデータを取得でき、データの利用側で制御せずにCMSやSNS、スマートフォンで表示することが可能です。また、認証に関しても、SPIRALの認証機構「マイエリア」の設定を利用することが出来ます。


  


スパイラルAPIを利用することで、SPIRALに設定済みのWebコンポーネントやDBにアクセスして情報の出し入れや、メール配信操作、マイエリアによる認証処理などを利用することが出来ます。
例えば、SPIRALへ外部システムからアクセスすることが可能になり、会員や顧客の大切な個人情報を安全なSPIRALのDBに預け、管理しやすくなります。また、APIを通して、SPIRALで設定したWebコンテンツを外部システムに出力したり、外部システムからメール配信操作を実行したりといった機能を活用し、柔軟なアプリケーション構築が可能になります。


APIリクエスト数

APIリクエスト数はデフォルトで1分間(※1)あたり10リクエストまで可能です。
リクエスト上限の変更(オプション※2)は、操作画面から変更いただけます。詳細は、機能詳細ページを参照ください。※2
※1 初回リクエストから1分間です。
※2 オプション価格についてはオプションページを参照ください。


APIメソッド

スパイラルAPIには様々なメソッドが用意されています。
それぞれのAPIの詳細に関しては、各機能のリンク先を参照して下さい。


ハイレベルAPI

ハイレベルAPIでは以下の機能を利用できます。
ハイレベルAPIのメソッドをご覧ください。


  • area(マイエリア認証)
    • login(マイエリアにログイン)
    • logout(マイエリアからログアウト)
    • status(ログイン状態の確認、セッション有効期間の延長)
    • mypage(マイエリアのカスタムマイページのURLを取得)


  • table(一覧表)
    • data(一覧表データを取得)
    • card(単票のURLを取得)


  • sumtable(集計表)
    • data(集計表データを取得)
    • count(集計を実行)
    • status(集計表のステータスを取得)


ローレベルAPI

ローレベルAPIでは以下の機能を利用できます。
ローレベルAPIのメソッドをご覧ください。


  • database(データベース)
    • insert(レコードの登録)
    • bulk_insert(複数レコードの一括登録)
    • update(レコードの更新)
    • delete(レコードの削除)
    • select(レコードの検索)
    • create(DBの新規作成)
    • get(DBの情報を取得)
    • alter(DBの設定を変更)
    • drop(DBを削除)


  • deliver_express2(Express2配信)
    • regist(配信設定の登録)
    • update(配信設定の更新)
    • cancel(配信設定の削除)
    • list(配信設定一覧の取得)
    • get(配信ルールの詳細情報を取得)
    • sampling(配信設定のサンプリング配信)


  • deliver_thanks(サンキューメール)
    • send(サンキューメールを送信)


  • db_filter(抽出ルール)
    • create(抽出ルールを作成)
    • list(抽出ルールのリストを出力)
    • get(抽出ルールの内容を取得)
    • delete(抽出ルールを削除)


  • push_notification(プッシュ通知)
    • send_for_ios(iOSアプリにプッシュ通知)
    • send_for_android(Androidアプリにプッシュ通知)


  • passbook(パスブック)
    • update(passファイルを更新)


  • custom_program(カスタムプログラム)
    • run(カスタムプログラムを実行)


  • custom_module(カスタムモジュール)
    • upload(カスタムモジュールをアップロード)


  • logs(ログ)
    • deliver(配信ログファイルを作成)


オープンAPI

SPIRALではシステムで提供しているスパイラルAPIとは別に、カスタムプログラムを外部から実行できるように設定することが可能です。
カスタムプログラムの編集画面においてオープンAPIを許可するにチェックを入れることで、ユーザ独自のプログラムをAPIトークンシークレットは使わずにAPIトークンのみで呼び出せるようになります。
設定方法などはカスタムプログラムでのPHP利用の「オープンAPIとして利用する」を参照下さい。


オープンAPIのメソッドををご覧ください。


その他

その他、各メソッド仕様時に参照していただく資料があります。以下のリンクからご覧ください。
その他仕様について


APIタイプ

スパイラルAPIでは複数のタイプのAPIメソッドが提供されています。
認証が必要なハイレベルAPIとより自由度の高いローレベルAPIに大きく分けることが出来ます。
オープンAPIも含めて、それぞれのタイプごとにAPIの特徴があります。


ハイレベルローレベルオープン
仕組みプロキシー型直接型カスタムプログラム経由
セッションマイエリアログインのセッションIDが必要無し。ステートレス無し。ステートレス
認証トークン + シークレット
+ マイエリアログインID
+ マイエリアパスワード
トークン + シークレットトークン (カスタムプログラム次第)
データ
アクセス範囲
マイエリアログインユーザ絞り込みあり全データカスタムプログラムで制御
処理設定・
制御方法
管理画面での設定 + クライアントプログラムクライアントプログラムカスタムプログラム
セキュリティ
柔軟性
生産性
目的第三者に配布されるフロントエンド
(スマホ等)との連携
サーバーサイド等の
自社プログラムとの連携
JavaScript等から
GETパラメータによる簡易な連携
(特に一般公開情報)


APIの外部呼出しと内部呼出し

外部呼出し
外部呼出しとは、スパイラル外のシステムからAPIを呼び出す場合に利用することを指します。
以下の特徴があります。

  • HTTP(S)通信のできる任意のプログラミング言語で利用可能
  • APIトークン、APIシークレットから算出するパスキー、リクエストの署名の3つの機構でAPI呼び出しの安全性を確保


内部呼出し
内部呼出しとは、スパイラル内からPHPプログラムを使ってAPIを実行することを指します。
以下の特徴があります。

  • フォーム、マイページ、カスタムプログラム等からAPIを呼び出す場合に利用
  • $SPIRALオブジェクトを使って簡単にDB操作ができます
  • APIコミュニケータを使って各種APIを呼び出すことができます

  


もちろん、スパイラル内部からであっても外部から呼び出す時と同じ方法に従ってAPIをコールすることも可能ですが、PHPの$SPIRALオブジェクトによりAPIトークンを意識することなく非常に容易にAPIを実行できます。
なお、PHPの利用にあたってはマニュアルを参照ください。



主な利用例

CMSとスパイラルを連携して会員サイト構築


  


スパイラルとCMSをAPIで連携して会員サイトを構築。
スパイラルを利用して、会員登録、登録情報の変更、会員ページへのログインなど、会員管理の仕組みを自由に設計・構築できます。会員情報はスパイラルで安全に管理し、コンテンツ管理はCMSを利用することで、会員認証やメール配信を組み込んだ会員サイトを構築することができます。


CMSとスパイラルを連携して複雑な業務アプリケーションを構築


  


スパイラルとCMSをAPIで連携して、CMSだけでは構築が難しかった複雑な業務アプリケーションを自由に構築。
例えば、顧客管理システムの場合、スパイラルAPIによるDB操作、配信操作を組み込むことで、システムへのログイン、顧客情報や対応履歴の登録・更新・削除、顧客へのメール配信などを実装した独自のシステムを構築できます。さらに、顧客管理システムからスパイラルの安全なDBから顧客情報を取得し、メーラーのインターフェースのような操作感覚でメールを送れるようにするなど、クライアントの運用に合わせたUIを開発することも可能です。


成約につなげる行動ターゲティングメール


  


自動車販売店では、試乗目的で来店したお客様にメールマガジンの会員登録を促し、新型車の情報やキャンペーン情報を配信していることがあります。メールマガジンの目的は見込客を成約客に育てることですが、メールから誘導したページの閲覧状況など、アクセス解析データを取得していても、データの分析や充分なフォローにはなかなか手が回りません。
スパイラルのオープンAPI、カスタムプログラムを使えば、一般的なアクセス解析データを取得するだけでなく、メールマガジン会員が閲覧したWebページに合わせてターゲティングメールを送ったり、購入確度の高いお客様が良く閲覧するページを閲覧した場合、営業へ電話アプローチを促す通知メールを送ったりすることができます。簡単なルールを定め、カスタムプログラムで実装するだけで、成約につなげる施策を実施できます。