スパイラルAPI
目 次 スパイラルAPI 1. スパイラルAPI 全 体 像 システム 構 成 2. APIトークンとAPIトークンシークレット 3. APIトークンとAPIトークンシークレットの 発 行 4. APIとして 提 供 しているメソッド APIにてデータ 取 得 可 能 なスパイラル 機 能 3 4 5 6 5. 認 証 (マイエリア) メソッド 一 覧 対 照 表 6. 一 覧 表 単 票 メソッド 一 覧 対 照 表 7.. 集 計 表 グラフ メソッド 一 覧 対 照 表 APIにて 操 作 設 定 できるスパイラル 機 能 7 11 13 16 20 22 8. DBオペレーション メソッド 一 覧 対 照 表 9. EXPRESS 2 メソッド 一 覧 対 照 表 10.THANKSメール 配 信 メソッド 一 覧 対 照 表 11.API 設 定 方 法 のポイント 12. 設 定 例 付 録. 比 較 演 算 子 一 覧 付 録.ファイル 型 フィールドを 使 用 する 場 合 の 通 信 フォーマット 24 25 28 29 34 35 37 41 45 47 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 2
1. スパイラルAPI 全 体 像 システム 構 成 スパイラルは 登 録 データから 一 覧 表 単 票 や 集 計 表 グラフを 作 成 表 示 するWebパーツ 機 能 を 備 えています スパイラルAPI では 各 Webパーツ 機 能 で 設 定 したロジックを 適 用 してデータを 取 得 でき データの 利 用 側 で 制 御 せずにCMSやSNS スマー トフォンで 表 示 することが 可 能 です また 認 証 においても スパイラルの 認 証 機 構 マイエリア の 設 定 を 利 用 することができます マイエリア はスパイラル に 登 録 した 会 員 情 報 をもとに 認 証 を 行 い スパイラル 内 に 設 置 した 会 員 ページ(カスタムマイページ)を 表 示 します ロケータURL http://www.pi-pe.co.jp/api/locator https://www.pi-pe.co.jp/api/locator 文 字 コードはUTF-8 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 3
2. APIトークンとAPIトークンシークレット APIトークン APIトークンは スパイラルのオプション 機 能 としてご 利 用 いただくユーザを 特 定 するための 文 字 列 で 通 信 のパラ メータとして 必 ず 送 信 する 必 要 があります APIトークンシークレット APIトークンのシークレットは リクエスト 時 通 信 データのメッセージ 認 証 コード(HMAC)を 生 成 するために 使 用 し 暗 号 で 例 えると 公 開 鍵 の 役 割 を 果 たします パラメータは 利 用 するAPI 機 能 により 異 なるデータです 詳 細 は スパイラルAPI 詳 細 資 料 データ 内 のメソッド 一 覧 をご 参 照 ください Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 4
3. APIトークンとAPIトークンシークレットの 発 行 開 発 スパイラルAPI メニューにアクセス 発 行 する ボタンを 押 してキーワードを 入 力 APIトークンとAPIトークンシークレットを 発 行 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 5
4. APIとして 提 供 しているメソッド 分 類 APIメソッド 名 内 容 ロケータ locator/apiserver APIトークンに 対 応 するAPIサーバのURLを 返 す 認 証 (マイエイリア) area/login area/logout area/status area/mypage マイエリアにログインし そのセッションIDを 返 す マイエリアからログアウトし セッションIDを 無 効 にする セッションIDを 引 数 として セッションが 有 効 かを 確 認 する 引 数 として 指 定 されたマイページのURLを 返 す 一 覧 表 table/data 一 覧 表 の 出 力 データを 返 す 集 計 表 sumtable/data 集 計 表 の 出 力 データを 返 す データベース Express2 database/insert database/update database/delete database/select deliver_express2/regist deliver_express2/update deliver_express2/cancel deliver_express2/list deliver_express2/sampling データベースに 対 して 1 件 のレコードを 登 録 データベースに 対 して 抽 出 した 複 数 件 のレコードを 更 新 データベースに 対 して 抽 出 した 複 数 件 のレコードを 削 除 データベースに 対 して 複 数 件 のレコードを 抽 出 Express2でメール 配 信 設 定 を 登 録 Express2でメール 配 信 設 定 を 更 新 Express2で 予 約 した 配 信 設 定 を 削 除 Express2で 予 約 した 配 信 設 定 一 覧 を 取 得 Express2で 予 約 した 配 信 設 定 のサンプリング 配 信 Thanksメール deliver_thanks/send 設 定 済 のThanksメール 配 信 設 定 に 対 して Thanksメールを 送 信 カスタムプログラム custom_program/run カスタムプログラムを 実 行 詳 細 は スパイラルAPI 詳 細 資 料 データ 内 のメソッド 一 覧 をご 参 照 ください Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 6
5. 認 証 (マイエリア) マイエリアとは 会 員 専 用 のマイページの 集 まりのことです マイエリア 機 能 を 用 いることで CGI などのプログラムを 必 要 とすることなく 会 員 専 用 ページや 会 員 専 用 アンケート 会 員 情 報 変 更 ページ 等 を 構 築 できます (1) 1つのマイエリアに 対 して 複 数 の 会 員 専 用 マイページを 使 用 した 構 成 可 能 マイエリアは 複 数 のマイページで 構 成 可 能 なため 様 々な 会 員 専 用 コンテンツを 提 供 するような 会 員 専 用 サイト が 構 築 できます もちろんシンプルに 会 員 専 用 アンケートのみのマイエリアも 設 定 できます (2) 複 数 のログイン 方 式 を 提 供 マイエリアへのログインには 大 きく 認 証 ログインと 非 認 証 ログインがあり 認 証 ログインではその 用 途 に 応 じ て5 種 類 の 方 式 があります (3) 1つのデータベースに 対 して 複 数 のマイエリアを 定 義 可 能 1 つの DB テーブルに 対 して 複 数 のマイエリアを 設 定 することができます クリックログインによる 会 員 専 用 ア ンケートを 実 施 しつつ ログイン ID とパスワードによる 認 証 が 必 要 な 会 員 専 用 エリアの 構 築 が 可 能 です Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 7
5. 認 証 (マイエリア) マイエリアへのログインは 5 種 類 の 認 証 方 法 を 提 供 しています Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 8
5. 認 証 (マイエリア) Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 9
5. 認 証 (マイエリア) データベースとマイエリアの 関 係 マイエリア 内 では 会 員 を 特 定 できているため その 会 員 の 属 性 情 報 を 差 し 込 むことができます Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 10
5. 認 証 (マイエリア) メソッド 一 覧 対 照 表 (フロー) マイエリアの タイトル 自 動 発 行 キー 会 員 識 別 キー パスワード セッションID マイページ 番 号 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 11
5. 認 証 (マイエリア) メソッド 一 覧 対 照 表 ( 操 作 画 面 ) マイエリア 発 行 画 面 マイエリアのタイトル カスタムマイページ 編 集 画 面 マイページ 番 号 会 員 識 別 キー 自 動 発 行 キー パスワード Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 12
6. 一 覧 表 単 票 一 覧 表 は データーベースのレコードを 一 覧 形 式 でウェブページに 表 示 する 機 能 です 単 票 は 一 覧 表 に 含 まれる1 件 を 選 択 し 詳 細 情 報 をウェブページに 表 示 する 機 能 です 一 覧 表 に 対 して 検 索 フォームを 設 置 して 一 覧 表 からデータを 指 定 の 条 件 で 絞 り 込 むことが 可 能 です Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 13
6. 一 覧 表 単 票 3 種 類 のアクセス 権 限 を 設 定 できます Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 14
6. 一 覧 表 単 票 マスタフィルタの 差 替 えキーワードを 使 用 することで マスタDBで 参 照 元 のデータをフィルタした 一 覧 表 を 表 示 させることができます Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 15
6. 一 覧 表 単 票 メソッド 一 覧 対 照 表 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 16
6. 一 覧 表 単 票 メソッド 一 覧 対 照 表 (フロー) マイエリアのタイトル 条 件 値 検 索 条 件 名 ページ 毎 のデータ 行 パスワード ページ 番 号 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 17
6. 一 覧 表 単 票 メソッド 一 覧 対 照 表 ( 操 作 画 面 ) 検 索 フォーム 設 定 画 面 一 覧 表 設 定 画 面 ソート 順 序 一 覧 表 検 索 フォームタイトル Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 18
6. 一 覧 表 単 票 メソッド 一 覧 対 照 表 ( 操 作 画 面 ) 通 常 DB 管 理 /フィールド 構 成 画 面 ソート 対 象 フィールド のフィールドタイトル Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 19
7. 集 計 表 グラフ 集 計 表 は 指 定 したDBのデータから 集 計 表 とグラフを 作 成 し Webページに 表 示 する 機 能 です 作 成 できる 集 計 表 は 以 下 の5 通 りになります それぞれ 指 定 できる 軸 数 集 計 するデータ 表 示 カラム 出 力 項 目 グラフが 異 なります Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 20
7. 集 計 表 グラフ Webページとパーツ Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 21
7. 集 計 表 グラフ メソッド 一 覧 対 照 表 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 22
7. 集 計 表 グラフ メソッド 一 覧 対 照 表 ( 操 作 画 面 ) 集 計 表 履 歴 画 面 集 計 表 タイトル 履 歴 番 号 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 23
8. DBオペレーション DBオペレーション とは データベースに 対 して データの 新 規 登 録 更 新 削 除 検 索 ができる 機 能 です 新 規 登 録 画 面 検 索 結 果 一 覧 画 面 検 索 画 面 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 24
8. DBオペレーション メソッド 一 覧 対 照 表 DBオペレーション 注 意 点 あらかじめ データベースは 作 成 してください 使 用 できる 文 字 コードは UTF8 パスワードフィールドは 操 作 できません ( 数 字 だけのデータの 場 合 操 作 可 能 ですが 文 字 は 一 切 入 りません) 比 較 演 算 子 については 付 録 をご 参 照 ください Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 25
8. DBオペレーション メソッド 一 覧 対 照 表 ( 操 作 画 面 ) DBオペレーション( 新 規 登 録 ) 画 面 登 録 データ 値 通 常 DB 管 理 /DB 情 報 一 覧 フィールド 属 性 一 覧 画 面 データベースのタイトル フィールドタイトル Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 26
8. DBオペレーション メソッド 一 覧 対 照 表 ( 操 作 画 面 ) DBオペレーション( 検 索 条 件 設 定 ) 画 面 DBオペレーション( 検 索 結 果 ) 画 面 検 索 条 件 条 件 値 比 較 演 算 子 データベースの 抽 出 ルール 設 定 画 面 ID 抽 出 ルール 名 ページ 毎 のデータ 行 数 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 27
9. EXPRESS 2 EXPRESS 2 とは データベースに 登 録 されているメールアドレスに 対 して メールを 配 信 できる 機 能 です 特 定 のルールに 従 って 対 象 者 を 抽 出 して 配 信 することもできます EXPRESS 2 ではメール 文 面 の 作 成,リストの 抽 出 から 配 信 登 録 までを1 画 面 で 行 うことができます 件 名 :パイプニュース 差 出 人 :パイプドビッツ 差 出 人 アドレス: support@pi-pe.co.jp 宛 先 :~~~@~~~~ -------------------------------- みなさんこんにちは ~~~~~~~~ ~~~~~~~~~ ~~~ URL:http://www.------- Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 28
9. EXPRESS 2 メソッド 一 覧 対 照 表 EXPRESS 2 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 29
9. EXPRESS 2 メソッド 一 覧 対 照 表 ( 操 作 画 面 ) 通 常 DB 管 理 /DB 情 報 一 覧 フィールド 属 性 一 覧 画 面 データベースのタイトル フィールドタイトル (メールアドレス 配 信 エラーフィールド オプトアウト) メールグループTOP/ 設 定 一 覧 ページ 番 号 ページ 毎 の データ 行 数 配 信 ルールID Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 30
9. EXPRESS 2 メソッド 一 覧 対 照 表 ( 操 作 画 面 ) EXPRESS 2/ 配 信 リスト 設 定 画 面 データベースの 抽 出 ルール 配 信 エラーを 自 動 反 映 EXPRESS 2/メールヘッダ 情 報 設 定 画 面 配 信 エラーを 除 外 する 除 外 するエラー 回 数 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 31
9. EXPRESS 2 メソッド 一 覧 対 照 表 ( 操 作 画 面 ) EXPRESS 2/メールヘッダ 情 報 設 定 画 面 件 名 差 出 人 名 差 出 人 メールアドレス DKIMセレクタ Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 32
9. EXPRESS 2 メソッド 一 覧 対 照 表 ( 操 作 画 面 ) EXPRESS 2/ 配 信 リスト メールヘッダ 情 報 設 定 画 面 テキスト 文 面 配 信 予 約 日 時 スタンバイ Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 33
10. THANKSメール 配 信 THANKSメール 配 信 登 録 ページから 登 録 があった 直 後 に その 登 録 メールアドレスを 宛 先 にして 配 信 されるメール をいいます メールマガジン 資 料 請 求 アンケートなど 利 用 シーンはさまざまです 登 録 ページ DB Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 34
10. THANKSメール 配 信 メソッド 一 覧 対 照 表 THANKSメール 配 信 注 意 点 配 信 作 業 のみ 対 応 しています (あらかじめ スパイラルの 管 理 画 面 から 登 録 ページ 設 定 とTHANKSメール 配 信 設 定 をしておく 必 要 が あります ) Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 35
10. THANKSメール 配 信 メソッド 一 覧 対 照 表 ( 操 作 画 面 ) THANKS 配 信 登 録 設 定 画 面 DBオペレーション( 検 索 結 果 ) 画 面 配 信 ルールID 宛 先 レコードの IDフィールド Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 36
11. APIの 呼 出 方 法 のポイント JSON POST X- SPIRAL- API API Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 37
11. APIの 呼 出 方 法 のポイント JSON POST HTTP Content- Type: application/ json; charset=utf- 8 API JSON POST " {'spiral_api_token':'00123abc...987','passkey':'123def...012', 'signature':'789023...a5f','jsessionid':'5678ab...90f', 'my_area_title':'mylogin','search_title':'search1','lines_per_page':'20'}" ; X- SPIRAL- API API Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 38
11. APIの 呼 出 方 法 のポイント JSON POST X- SPIRAL- API HTTP X- SPIRAL- API: table/ data/ request / / API Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 39
11. APIの 呼 出 方 法 のポイント JSON POST X- SPIRAL- API API POST spiral_api_token, passkey, signature " {'spiral_api_token':'00123abc...987','passkey':'123def...012', 'signature':'789023...a5f','jsessionid':'5678ab...90f',... spiral_api_token passkey signature "API &passkey" API hmacsha1 API Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 40
12. 設 定 例 属 性 情 報 を 取 得 する Q.APIでマイエリアへログイン 後 名 前 とメールアドレスを 取 得 したい A.カスタムマイページを 作 成 し APIの area/mypage 機 能 を 使 用 し 取 得 します ID パスワード 名 前 メールアドレス 1 パイプ 太 郎 hogehoge@pi-pe.co.jp 準 備 1 マイエリアを 発 行 します マイエリアの 発 行 方 法 については ユーザーガイド マイエリアガイド http://www.pi-pe.co.jp/help/manual/ug_web-myarea_29.pdf をご 参 照 ください Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 41
12. 設 定 例 2 カスタムマイページを 作 成 します 1. マイエリア 設 定 で 発 行 したマイエリアを 選 択 し 設 定 を 呼 び 出 します 2. カスタムマイページ をクリックします 4.カスタムマイページソース 編 集 の 画 面 で マイペ ージIDを 確 認 します ページソース の 中 に 取 得 したいデータの 差 替 えキーワードを 設 定 します ( 差 替 えキーワード 表 示 を 押 すと 一 覧 が 表 示 されます) マイページ 番 号 3. 追 加 のボタンを 押 します 1 行 に1キーワード ずつ 入 力 します Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 42
12. 設 定 例 APIで 呼 び 出 す 1 マイエリアにログインする 際 の 情 報 (ex:id+パスワード)を 設 定 し セッションID(jsessionid)を 取 得 します ( の 箇 所 を 設 定 します passkey signatureの 設 定 については スパイラル API 設 定 資 料 データ http://www.pi-pe.co.jp/help/manual/api_data.pdf をご 参 照 ください ) ログインする 際 の 情 報 を 設 定 セッションID(jsessionid)を 取 得 2 取 得 したセッションID(jsessionid)から カスタムマイページのURLを 取 得 します 1で 取 得 したセッションID(jsessionid)を 設 定 カスタムマイページURLを 取 得 (URL:http:~~~~~) Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 43
12. 設 定 例 3 ページデータを 取 得 するためのプログラムを 作 成 の 上 カスタムマイページのデータをHTTPSで 取 得 します プログラム カスタムマイページURL http:~~~~~ カスタムマイページのデータ 取 得 文 字 コードはShift-JIS Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 44
付 録. 比 較 演 算 子 一 覧 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 45
付 録. 比 較 演 算 子 一 覧 Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 46
付 録.ファイル 型 フィールドを 使 用 する 場 合 の 通 信 フォーマット ファイル 型 フィールドを 使 用 する 場 合 必 ずマルチパート 形 式 をご 利 用 ください 改 行 コードは CRLF となります ファイル 型 フィールドのタイトルはJSONで 指 定 する 必 要 はありません ファイル 型 フィールドを 使 用 しない 場 合 従 来 の 通 信 フォーマット(シングルパート 形 式 )とマルチパート 形 式 の 両 方 を 利 用 できます 以 下 のようなマルチパート 形 式 のフォーマットを 利 用 します Java PHPのサンプルコードがあります ご 活 用 ください http://www.pi-pe.co.jp/help/manual/samples_for_filetype.zip [HTTP ヘッダ] Content-Type: multipart/form-data; boundary="xxxxxxxxxx_multipart_boundary" X-SPIRAL-API: 機 能 名 /メソッド 名 /request SPIRAL API ヘッダ [HTTPボディ] --xxxxxxxxxx_multipart_boundary Content-Type: application/json; charset="utf-8" Content-Disposition: form-data; name="json" 固 定 文 字 JSONデータ JSONパート { } "spiral_api_token": xxxxxxxxxxxxxxxxxxxxx", --xxxxxxxxxx_multipart_boundary 固 定 文 字 Content-Type: application/octet-stream; Content-Disposition: form-data; name="file01"; filename="ファイル01.png" [ファイルのバイナリデータ] --xxxxxxxxxx_multipart_boundary-- na,me : フィールドタイトル filename : ファイル 名 ファイルパート Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 47
従 来 の 通 信 フォーマット(シングルパート 方 式 ) [HTTPヘッダ] Content-Type: application/json; charset="utf-8" X-SPIRAL-API: xxxxx/yyyyy/request [HTTPボディ] { "spiral_api_token": xxxxxxxxxxxxxxxxxxxxx", } 固 定 文 字 SPIRAL API ヘッダ --- JSONデータ Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 48
ご 質 問 がございましたら スパイラル ユーザーズデスク よりお 気 軽 にお 呼 び 出 しください 専 門 スタッフより すぐに 折 り 返 しご 連 絡 差 し 上 げます スパイラルにログインし 操 作 画 面 最 上 部 の [ ユーザーズデスク ] ボタンをクリックしてください ポップアップで ユーザーズデスクご 連 絡 フォーム が 開 きます ユーザーズデスク 受 付 時 間 ユーザーズデスクについて 10:00~18:00 ( 土 日 祝 祭 日 年 末 年 始 休 業 を 除 く) http://www.smp.ne.jp/usersdesk/ Copyright 2011 PIPEDBITS Co.,Ltd. All rights Reserved. 49