ver.2サポートサイト

サイト認証

cURLライブラリを使用して、サイト認証エリアのログイン、トークンの有効性確認、ワンタイムURL発行、ログアウトをするサンプルプログラムです。
PHPにcurlライブラリが組み込まれている必要があります。

APIバージョンはver.1.1でのみ使用できます。

<?php

//SPIRAL Ver2のAPI用のURL
$base_url = "https://api.spiral-platform.com/v1/";
$url = $base_url."sites/{siteId}/authentications/{authenticationId}";

//APIキー
$apikey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";

//ヘッダ
$header = array(
"Authorization:Bearer ".$apikey,
"Content-Type:application/json",
"X-Spiral-App-Authority"."manage",
);

//------------------------------
//ログイン
//------------------------------

//urlの末尾にmethodを付加
$url = $url."/login";

//ログインしたいレコード情報を設定
//ボディ
$body = [
"id" => "test01",
"password" => "pass01"
];

//配列をjson形式に変換
$json_body = json_encode($body);

// curlライブラリを使用して送信
//セッションを初期化する
$curl = curl_init();

//実行結果を文字列で取得できるように設定
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
//urlを指定
curl_setopt($curl, CURLOPT_URL , $url);
//ヘッダを指定
curl_setopt($curl, CURLOPT_HTTPHEADER , $header);
//ボディを指定
curl_setopt($curl, CURLOPT_POSTFIELDS , $json_body);
//メソッドを指定
curl_setopt($curl, CURLOPT_CUSTOMREQUEST , 'POST');

//セッションを実行し、その結果を取得
$response = curl_exec($curl);

//cURLのエラーメッセージを表示
if (curl_errno($curl)) echo curl_error($curl);

//セッションを閉じる
curl_close($curl);

//json形式を配列に変換して表示
print_r(json_decode($response , true));

//------------------------------
//トークンの有効性確認
//------------------------------

//urlの末尾にmethodを付加
$url = $url."/status";

//ボディ
$body = [
//有効性を確認したいトークンを設定
"token" => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
//トークンの有効期限の延長
"extendExpireTime" => "true",
];

//配列をjson形式に変換
$json_body = json_encode($body);

// curlライブラリを使用して送信
//セッションを初期化する
$curl = curl_init();

//実行結果を文字列で取得できるように設定
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
//urlを指定
curl_setopt($curl, CURLOPT_URL , $url);
//ヘッダを指定
curl_setopt($curl, CURLOPT_HTTPHEADER , $header);
//ボディを指定
curl_setopt($curl, CURLOPT_POSTFIELDS , $json_body);
//メソッドを指定
curl_setopt($curl, CURLOPT_CUSTOMREQUEST , 'POST');

//セッションを実行し、その結果を取得
$response = curl_exec($curl);

//cURLのエラーメッセージを表示
if (curl_errno($curl)) echo curl_error($curl);

//セッションを閉じる
curl_close($curl);

//json形式を配列に変換して表示
print_r(json_decode($response , true));

//------------------------------
//ワンタイムURL発行
//------------------------------

//urlの末尾にmethodを付加
$url = $url."/oneTimeLogin";

//ボディ
$body = [
//有効性を確認したいトークンを設定
"token" => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
//ワンタイムURLを発行したい認証エリアのページパスを設定
"path" => "/XXXXX/XXXXX",
];

//配列をjson形式に変換
$json_body = json_encode($body);

// curlライブラリを使用して送信
//セッションを初期化する
$curl = curl_init();

//実行結果を文字列で取得できるように設定
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
//urlを指定
curl_setopt($curl, CURLOPT_URL , $url);
//ヘッダを指定
curl_setopt($curl, CURLOPT_HTTPHEADER , $header);
//ボディを指定
curl_setopt($curl, CURLOPT_POSTFIELDS , $json_body);
//メソッドを指定
curl_setopt($curl, CURLOPT_CUSTOMREQUEST , 'POST');

//セッションを実行し、その結果を取得
$response = curl_exec($curl);

//cURLのエラーメッセージを表示
if (curl_errno($curl)) echo curl_error($curl);

//セッションを閉じる
curl_close($curl);

//json形式を配列に変換して表示
print_r(json_decode($response , true));

//------------------------------
//ログアウト
//------------------------------

//urlの末尾にmethodを付加
$url = $url."/logout";

//ボディ
$body = [
//ログアウトしたいトークンを設定
"token" => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
];

//配列をjson形式に変換
$json_body = json_encode($body);

// curlライブラリを使用して送信
//セッションを初期化する
$curl = curl_init();

//実行結果を文字列で取得できるように設定
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
//urlを指定
curl_setopt($curl, CURLOPT_URL , $url);
//ヘッダを指定
curl_setopt($curl, CURLOPT_HTTPHEADER , $header);
//ボディを指定
curl_setopt($curl, CURLOPT_POSTFIELDS , $json_body);
//メソッドを指定
curl_setopt($curl, CURLOPT_CUSTOMREQUEST , 'POST');

//セッションを実行し、その結果を取得
$response = curl_exec($curl);

//cURLのエラーメッセージを表示
if (curl_errno($curl)) echo curl_error($curl);

//セッションを閉じる
curl_close($curl);

//json形式を配列に変換して表示
print_r(json_decode($response , true));

?>