ユーザー
users > get
ユーザー情報をリクエストします。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | users | APIセクション |
| do | get | APIアクション |
| iq | User ID | ユーザーID |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=users&do=get&iq={user_id}&{required information}
POST変数
このリクエストにはPOST変数は必要ありません。
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・data：ユーザー情報
{
"data": {
"access_level": "0",
"activation_key": "u4o3cv0wz3u1w3r6rjay",
"address": "",
"alias": "testuser",
"avatar_display": "0",
"birthdate": "0000-00-00",
"cms_access": "1",
"company": "",
"content_creation_limits":"0",
"country": "Usa",
"date_lastmod": "1426093858",
"email": "sampleemail@domain.ext",
"gender": "1",
"general_cvp_expiration": "0",
"id": "1",
"id_privilege_set": "1",
"img_gravatar_url": "",
"img_icon": "http:\/\/......\/public\/common\/images\/_default_user_icon.gif",
"img_social": "http:\/\/......\/public\/common\/images\/_default_user_social.gif",
"img_thumbnail": "http:\/\/......\/public\/common\/images\/_default_user_thumb.gif",
"last_ip": "xxx.xxx.xxx.xxx",
"last_ip_update": "1427695411",
"last_login": "1427695411",
"login": "admin",
"max_created_channels":"5",
"max_created_clips":"[\"100\",\"100\",\"1\",\"100\",\"100\"]",
"max_created_galleries":"5",
"max_created_news":"5",
"max_created_assorted_files":"5",
"max_video_upload_size":"300",
"name": "",
"notes": "",
"postal_code": "",
"profile_page_about": "The INTER-STREAM Admin....",
"profile_page_privacy": "0",
"profile_page_show_country": "1",
"profile_page_show_social": "1",
"profile_page_show_web": "1",
"reg_ip": "xxx.xxx.xxx.xxx",
"reg_referer": "",
"reg_timestamp": "0",
"reg_useragent": "",
"session_id": "q6mvdcliagb55mrjylzq",
"session_time": "1427695426",
"social_page_facebook": "",
"social_page_flickr": "",
"social_page_googleplus": "",
"social_page_linkedin": "",
"social_page_other": "",
"social_page_tuenti": "",
"social_page_twitter": "",
"social_page_vkontakte": "",
"status": "1",
"surname": "",
"telephone": "",
"url": "http:\/\/......\/index.php\/portal\/user\/1\/testuser\/",
"user_groups": [{
"id": "1",
"title": "Group 1"
}, {
"id": "2",
"title": "Group 2"
}],
"vat": "",
"web": "http:\/\/......\/"
}
}
リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス
{
"error" : "REQUEST_ERROR",
"error_long" : "Missing signature"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid User ID
ユーザーIDが1未満かもしくは数値ではありません。
・REQUEST_ERROR | User not found
ユーザーが見つかりません。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array( "go" => "users", "do" => "get", "iq" => 1 ); // POST変数 $POST_VARS = array();
salt, timestamp, signatureを生成してリクエストを送信します。
以下のコードブロックはすべてのハッシュつきリクエストに共通です。
// APIベースURLと認証情報の収集
$API_URL = "https://www.interstreamdomain.tv/api.php";
$API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee";
$API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // 公開しないでください
// salt, timestamp, signatureの生成
$salt = md5(mt_rand());
$timestamp = time();
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true));
// key, salt, timestamp, signatureをGET変数に追加
$GET_VARS["timestamp"] = $timestamp; // UTCタイムスタンプ
$GET_VARS["salt"] = $salt;
$GET_VARS["key"] = $API_KEY_ID ; // APIキーID:これは公開されており、アプリケーションを識別するためにAPIによって使用されます
$GET_VARS["signature"] = $signature;
// リクエストURLを作成します。HTTPクエリを作成するためにPHPの組み込み関数を使用しない場合は、値をURLエンコードすることを忘れないでください。
$REQUEST_URL = $API_URL."?".http_build_query($GET_VARS);
// ".../api.php?go=api_subject&do=api_action&etc..."のようにURLを構築
// 新しいcURLリソースを作成して適切なオプションを設定
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $REQUEST_URL);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, $POST_VARS);
// PHPホストに有効なSSL証明書がない場合は、SSL証明書の検証を無効にする必要があります。これは危険であり、有効な証明書がインストールされるまで一時的に行われるべきです。
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate.
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate.
// APIにリクエストを送信
$response = curl_exec($ch);
// レスポンス処理
if (!$response) {
echo 'API call failed';
}
else
{
print_r(json_decode($response,true));
}