スパイラルAPI

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

スパイラルAPI概要

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

APIのリクエスト数・利用料

なお、スパイラル ver.1.11.5よりすべてのアカウントにおいてスパイラルAPIを標準でご利用いただけるようになりました。ただし、APIリクエスト数の制約は毎分10リクエストまでというかなり制限されたものとなっており、あくまでもAPIをお試していただくためのものとなります。よって、本格的にAPIを使ったアプリケーションを構築される際には、別途オプション契約を行って頂く必要があります。

サービス名 適用 価格
スパイラルAPI利用料 月次(1アカウント) 5,000円

このAPI利用オプションを有効にしていただくことで毎分600リクエストまでAPIをコールしていただくことが可能です。なお、このリクエスト数を超えてAPIを実行したい場合は、別途ご相談下さい。

APIメソッド

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

ハイレベルAPI

機能 メソッド
area
マイエリア(認証)
login マイエリアにログイン
logout マイエリアからログアウト
status ログイン状態の確認、セッション有効期間の延長
mypage マイエリアのカスタムマイページのURLを取得
table
一覧表
data 一覧表データを取得
card 単票のURLを取得
sumtable
集計表
data 集計表データを取得
count 集計を実行
status 集計表のステータスを取得

ローレベル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の特徴を以下に示しています。利用シーンなどに応じて適宜使い分けるようにしましょう。

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

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

APIの呼び出し方法

外部呼び出しには以下の特徴があります。

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

これに対して、APIの内部呼び出しとはスパイラル内からPHPプログラムを使ってAPIを実行することを指しており

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

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