印刷する

ユーザー

users > list

ユーザー一覧をリクエストします。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数値説明
gousersAPIセクション
dolistAPIアクション

リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。

https://....../api.php?go=users&do=list&{required information}
POST変数

以下のリストフィルターはPOST変数を使って利用できます。フィルターは複数同時に使用可能です。

変数値説明
fields (string) "field1,field2,..." 結果に含めるフィールドを指定します。
"*" = すべてのフィールド（デフォルト）
"field1, field2, field3" = フィールドのサブセット（推奨/カンマ区切り）
可能なフィールド：
id, status, access_level, login, password, alias, img_social, img_thumbnail, img_icon, avatar_display, name, surname, email, birthdate, address, country, telephone, web, social_page_facebook, social_page_googleplus, social_page_twitter, social_page_linkedin, social_page_flickr, social_page_tuenti, social_page_vkontakte, social_page_other, notes, activation_key, reg_timestamp, reg_useragent, reg_ip, last_login, session_id, session_time, general_cvp_expiration, profile_page_privacy, profile_page_about, profile_page_show_country, profile_page_show_web, profile_page_show_social, cms_access, date_lastmod, company, vat, postal_code, gender, last_ip, last_ip_update, reg_referer, img_player_logo, img_player_logo_url
ページングオプション
resultsPerPageFilter (int) n 1ページあたりの結果の数（何件表示か）
current_page (int) n 現在のページ数（何ページ目か）
paging (int) 0|1 ページングを有効/無効にする
limit (int) n 結果制限
※"resultsPerPageFilter"が未設定かつ"paging=0"の場合のみ
よく使われるフィルター
statusFilter (mixed) status 指定したステータスに一致するユーザーを一覧表示します。
利用可能な値："any", 0(非アクティブ), 1(アクティブ), 2(保留中), 11(ログイン), 12(ログアウト), 13(自動ログアウト)
sortByFilter (string) "option" リストを並べ替えます。
利用可能な値："reg_timestamp"(デフォルト), "email", "login", "alias", "id"
idFilter string) "ID1,ID2,..." IDが指定されたものと一致するユーザーを一覧表示します（カンマ区切り）。
アクセスレベルフィルター
accessLevelFilter (int) access level 指定されたアクセスレベルと一致するアクセスレベルのユーザーを一覧表示します。
accessLevelFilterLowerThan (int) access level 以下の指定されたアクセスレベルのユーザーを一覧表示します。
アクセスレベル：0(ウェブマスター), 1(管理者), 2(寄稿者), 3(投稿者), 4,5(購読者)
検索フィルター
search (string) "term" 検索する用語。
検索は"ログイン+ユーザー名+メール"のフィールドで実行されます。
ユーザーグループフィルター
userGroupFilter (mixed) "User Group ID" 利用可能な値："any", -1(どのグループにも関連付けられていないユーザー), ユーザーグループID(0より大きい整数)

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・list_total_found：（ページングの目的で）基準に一致した、見つかったアイテムの合計数。
・list_total：返されたリストの項目数。これは通常"limit"もしくは"resultsPerPageFilter"の値と一致します。
・list：アイテムリスト

{
    "list_total_found": "16",
    "list_total": 5,
    "list": [{
        "alias": "Elisa",
        "email": "elisa@emaildomain.ext",
        "id": "77",
        "login": "elisita",
        "url": "http:\/\/......\/index.php\/portal\/user\/77\/elisita\/"
    }, {
        "alias": "Mari",
        "email": "mari@emaildomain.ext",
        "id": "68",
        "login": "marian",
        "url": "http:\/\/......\/index.php\/portal\/user\/68\/marian\/"
    }, {
        "alias": "Ralph",
        "email": "ralph@emaildomain.ext",
        "id": "33",
        "login": "ralph2000",
        "url": "http:\/\/......\/index.php\/portal\/user\/33\/ralph2000\/"
    }, {
        "alias": "John",
        "email": "john@emaildomain.ext",
        "id": "32",
        "login": "johnny",
        "url": "http:\/\/......\/index.php\/portal\/user\/32\/johnny\/"
    }, {
        "alias": "Allice",
        "email": "allice@emaildomain.ext",
        "id": "31",
        "login": "allice",
        "url": "http:\/\/......\/index.php\/portal\/user\/31\/allice\/"
    }
}

認証情報にGETの許可がない場合など、リクエストが失敗した場合のレスポンス

{
	"error"		 : "REQUEST_ERROR",
	"error_long" : "Permission error: GET"
}

このリクエストは以下のエラーを返す可能性があります。

・REQUEST_ERROR | No Users were found
ユーザーが見つかりません。

その他のエラー内容に関しては一般的なエラーメッセージを確認してください。

PHPサンプルコード

GETおよびPOSTデータを準備します。

// GET変数
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "list"
					);

// POST変数
$POST_VARS = array(
					"fields"				=> "id,email,alias,login", 	// ID、メール、ユーザー名、ログインのみ表示
					"paging"				=> 1, 			// ページング有効
					"resultsPerPageFilter"	=> 5, 			// 1ページにつき5件表示
					"current_page"			=> 1,			// 1ページ目に戻る
					"statusFilter"			=> "any"		// 全てのステータスのユーザーを表示
                    );

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)); 
}