スパイラルAPI APIタイプについて

スパイラルAPI　APIタイプについて
SPIRAL
Tech Boot Camp
株式会社パイプドビッツ
Copyright © PIPEDBITS Co.,Ltd. All rights Reserved.
1
１．APIの3つのタイプ
ハイレベル
ローレベル
オープン
API
一覧表
一覧表
Proxy
（代理人）
カスタム
プログラム
API
APIクライアント
Copyright © PIPEDBITS Co.,Ltd. All rights Reserved.
API
APIクライアント
API
APIクライアント
2
２．ハイレベルとローレベルAPIの違い
ハイレベル
ローレベル
•  SPIRALのWebコンポーネントをプロキシー（代理人）を
使って操作し、ブラウザへのHTMLでの出力の代わりに、
JSONとして出力する仕組みです
•  各Webコンポーネントが配置されているマイエリアにログイ
ンし、そのセッションIDを使って、各コンポーネントにアク
セスします
•  ブラウザへの出力と同様に、管理画面で各種の設定を行いま
す
•  マイエリア認証、一覧表、集計表のAPIがあります
•  SPIRAL Webコンポーネントの裏側にある機能（DB、配信
等）を直接操作します
•  セッションIDは不要です
•  ハイレベルAPIよりも柔軟性の高い操作を行うことができます
が、書くコード量は相対的に増えます
•  DB、抽出ルール、EXPRESS配信、THANKS配信、プッ
シュ通知等のAPIがあります
Copyright © PIPEDBITS Co.,Ltd. All rights Reserved.
3
３．オープンAPIとは
•  APIシークレットを利用することな
く、トークンのみでアクセス可能で
す
※秘匿性の高い情報のアクセスには不向きです
カスタム
プログラム
オープンAPI
許可
カスタム
プログラム
アクセス不可
オープン
API
•  JavaScriptのようにソースコード
を判読可能なAPIクライアントで主
に利用します
•  引数付きでカスタムプログラムを呼
び出し、実行結果を返すAPIです
•  各カスタムプログラムで、オープン
APIとして呼び出し可能かを設定す
ることができます
JavaScript
APIクライアント
Copyright © PIPEDBITS Co.,Ltd. All rights Reserved.
4
４．オープンAPIの作成方法
•  カスタムプログラムのプロパティで
オープンAPIを「許可する」と、
オープンAPIとして利用できます
•  GETパラメータで呼び出すことがで
きます
オープンAPIを「許可する」
•  セキュリティの観点から、オープン
API呼び出し用のAPIトークンを作
成することをお勧めします
•  オープンAPIは以下のように呼び出
します
オープンAPI呼び出しサ
ンプル
Copyright © PIPEDBITS Co.,Ltd. All rights Reserved.
https://xxx.smp.ne.jp/api/service/
custom_program/run/request?
spiral_api_token=APIトークン&title=カ
スタムプログラムタイトル&callback=
コールバック関数名
5
５．各APIタイプの特長
項目
ハイレベル
ローレベル
オープン
仕組み
プロキシー型
直接型
カスタムプログラム経由
セッション
マイエリアログインの
セッションIDが必要
無し。ステートレス
無し。ステートレス
認証
トークン + シークレッ
ト + マイエリアログイ
ンID + マイエリアパス
ワード
トークン + シークレッ
トトークン
（カスタムプログラム次
第）
データアクセスマイエリアログイン
範囲
ユーザ絞り込みあり
全データ
カスタムプログラムで制
御
処理設定・制御管理画面での設定 + ク
方法
ライアントプログラム
クライアントプログラ
ム
カスタムプログラム
セキュリティ
◎
△
○
柔軟性
△
◎
○
生産性
○
◎
△
サーバーサイド等の自
社プログラムとの連携
JavaScript等からGETパ
ラメータによる簡易な連
携（特に一般公開情報）
目的
第三者に配布されるフ
ロントエンド（スマホ
等）との連携
Copyright © PIPEDBITS Co.,Ltd. All rights Reserved.
6

Download Report