概要
account/verify_credentialsは、認証ユーザー(アクセストークンの主)のアカウントが有効な状態か否かを確認するためのエンドポイントです。有効な場合は、ユーザーオブジェクトを取得できます。参加型のアプリケーションを運営していて、ユーザーによるTwitter連携などが発生した場合の確認手段として有用です。
このページでは、Twitter Rest APIのエンドポイント、account/verify_credentials(GETメソッド)について、説明しています。認証ユーザー(アクセストークンの主)のアカウントが有効な状態か否かを確認するためのエンドポイントです。
account/verify_credentialsは、認証ユーザー(アクセストークンの主)のアカウントが有効な状態か否かを確認するためのエンドポイントです。有効な場合は、ユーザーオブジェクトを取得できます。参加型のアプリケーションを運営していて、ユーザーによるTwitter連携などが発生した場合の確認手段として有用です。
account/verify_credentialsのリクエスト概要を説明します。
GET https://api.twitter.com/1.1/account/verify_credentials.json
ユーザー認証 | アプリケーション認証 | |
---|---|---|
対応 | ● | × |
パーミッション | Read Only | - |
レートリミット | 15 / 15min | - |
下記のパラメータをオプションとして指定できます。
entities
プロパティを含めるか否か。true
status
プロパティを除外するか否か。true
の場合は除外する。true
true
にした場合、取得するユーザーオブジェクトにEメールを含める。それにはアプリケーションがTwitterのホワイトリストに含まれている必要があるが、2015年現在、ホワイトリスト制度は廃止されているため、実質、利用できない…。false
リクエスト成功時に取得できるJSONのサンプルです。私のアカウントの有効性を確認した結果です。このJSONには、ユーザーオブジェクトが含まれます。
JSON
{"id":1528352858,"id_str":"1528352858","name":"\u3042\u3089\u3086","screen_name":"arayutw","location":"Japan","description":"\u8db3\u7acb\u533a\u5728\u4f4f\u3001\u30a6\u30a7\u30d6\u5236\u4f5c\u304c\u5927\u597d\u304d\u3067\u3059\u3002","url":"http:\/\/t.co\/ScEV7AVZSN","entities":{"url":{"urls":[{"url":"http:\/\/t.co\/ScEV7AVZSN","expanded_url":"http:\/\/syncer.jp","display_url":"syncer.jp","indices":[0,22]}]},"description":{"urls":[]}},"protected":false,"followers_count":802,"friends_count":516,"listed_count":47,"created_at":"Tue Jun 18 17:28:51 +0000 2013","favourites_count":2015,"utc_offset":32400,"time_zone":"Tokyo","geo_enabled":true,"verified":false,"statuses_count":9697,"lang":"ja","status":{"created_at":"Tue Aug 11 03:55:56 +0000 2015","id":630950750529568768,"id_str":"630950750529568768","text":"@genkiszk orz","source":"\u003ca href=\"http:\/\/twitter.com\" rel=\"nofollow\"\u003eTwitter Web Client\u003c\/a\u003e","truncated":false,"in_reply_to_status_id":630946636978503680,"in_reply_to_status_id_str":"630946636978503680","in_reply_to_user_id":401860228,"in_reply_to_user_id_str":"401860228","in_reply_to_screen_name":"genkiszk","geo":null,"coordinates":null,"place":null,"contributors":null,"retweet_count":0,"favorite_count":0,"entities":{"hashtags":[],"symbols":[],"user_mentions":[{"screen_name":"genkiszk","name":"\u3052\u3093\u304d@\u3056\u3063\u304f\u3056\u304f","id":401860228,"id_str":"401860228","indices":[0,9]}],"urls":[]},"favorited":false,"retweeted":false,"lang":"und"},"contributors_enabled":false,"is_translator":false,"is_translation_enabled":true,"profile_background_color":"292F33","profile_background_image_url":"http:\/\/abs.twimg.com\/images\/themes\/theme12\/bg.gif","profile_background_image_url_https":"https:\/\/abs.twimg.com\/images\/themes\/theme12\/bg.gif","profile_background_tile":false,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/602134400927563776\/D1MIOU6L_normal.png","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/602134400927563776\/D1MIOU6L_normal.png","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/1528352858\/1431758572","profile_link_color":"D36015","profile_sidebar_border_color":"F2E195","profile_sidebar_fill_color":"FFF7CC","profile_text_color":"0C3E53","profile_use_background_image":false,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":false,"follow_request_sent":false,"notifications":false}
手軽にaccount/verify_credentialsのエンドポイントを試したい人のために、コンソールを用意しました。オプションパラメータを調整して、リクエストを試すことができます。ご利用には、アプリケーションの認証が必要です。ご利用後は大変お手数ですが、連携を解除して下さい。
アプリケーション連携の解除は、下記ページから行なって下さい。アプリケーションが、あなたの操作(デモの確認)なしで、データにアクセスすることはありません。
account/verify_credentialsのエンドポイントを利用するためのサンプルプログラムを用意しました。各種トークンの情報をセットしてから、PHPで起動してみて下さいね。リクエストが成功すると、$json
という変数に、目的のデータが代入されます。後は、このデータを整形するなり、保存するなり、活用して下さい。
PHP
<?php
/**************************************************
[GET account/verify_credentials]のお試しプログラム
認証方式: アクセストークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/get/account/verify_credentials
日本語解説ページ: https://syncer.jp/twitter-api-matome/get/account/verify_credentials
**************************************************/
// 設定
$api_key = '' ; // APIキー
$api_secret = '' ; // APIシークレット
$access_token = '' ; // アクセストークン
$access_token_secret = '' ; // アクセストークンシークレット
$request_url = 'https://api.twitter.com/1.1/account/verify_credentials.json' ; // エンドポイント
$request_method = 'GET' ;
// パラメータA (オプション)
$params_a = array(
// 'include_entities' => 'true' , // ツイートオブジェクトのエンティティを含める
// 'skip_status' => 'true' , // ツイートオブジェクトの省略
// 'include_email' => 'false' , // Eメールを含めるか?
) ;
// キーを作成する (URLエンコードする)
$signature_key = rawurlencode( $api_secret ) . '&' . rawurlencode( $access_token_secret ) ;
// パラメータB (署名の材料用)
$params_b = array(
'oauth_token' => $access_token ,
'oauth_consumer_key' => $api_key ,
'oauth_signature_method' => 'HMAC-SHA1' ,
'oauth_timestamp' => time() ,
'oauth_nonce' => microtime() ,
'oauth_version' => '1.0' ,
) ;
// パラメータAとパラメータBを合成してパラメータCを作る
$params_c = array_merge( $params_a , $params_b ) ;
// 連想配列をアルファベット順に並び替える
ksort( $params_c ) ;
// パラメータの連想配列を[キー=値&キー=値...]の文字列に変換する
$request_params = http_build_query( $params_c , '' , '&' ) ;
// 一部の文字列をフォロー
$request_params = str_replace( array( '+' , '%7E' ) , array( '%20' , '~' ) , $request_params ) ;
// 変換した文字列をURLエンコードする
$request_params = rawurlencode( $request_params ) ;
// リクエストメソッドをURLエンコードする
// ここでは、URL末尾の[?]以下は付けないこと
$encoded_request_method = rawurlencode( $request_method ) ;
// リクエストURLをURLエンコードする
$encoded_request_url = rawurlencode( $request_url ) ;
// リクエストメソッド、リクエストURL、パラメータを[&]で繋ぐ
$signature_data = $encoded_request_method . '&' . $encoded_request_url . '&' . $request_params ;
// キー[$signature_key]とデータ[$signature_data]を利用して、HMAC-SHA1方式のハッシュ値に変換する
$hash = hash_hmac( 'sha1' , $signature_data , $signature_key , TRUE ) ;
// base64エンコードして、署名[$signature]が完成する
$signature = base64_encode( $hash ) ;
// パラメータの連想配列、[$params]に、作成した署名を加える
$params_c['oauth_signature'] = $signature ;
// パラメータの連想配列を[キー=値,キー=値,...]の文字列に変換する
$header_params = http_build_query( $params_c , '' , ',' ) ;
// リクエスト用のコンテキスト
$context = array(
'http' => array(
'method' => $request_method , // リクエストメソッド
'header' => array( // ヘッダー
'Authorization: OAuth ' . $header_params ,
) ,
) ,
) ;
// パラメータがある場合、URLの末尾に追加
if( $params_a )
{
$request_url .= '?' . http_build_query( $params_a ) ;
}
// オプションがある場合、コンテキストにPOSTフィールドを作成する (GETの場合は不要)
// if( $params_a )
// {
// $context['http']['content'] = http_build_query( $params_a ) ;
// }
// cURLを使ってリクエスト
$curl = curl_init() ;
curl_setopt( $curl , CURLOPT_URL , $request_url ) ;
curl_setopt( $curl , CURLOPT_HEADER, 1 ) ;
curl_setopt( $curl , CURLOPT_CUSTOMREQUEST , $context['http']['method'] ) ; // メソッド
curl_setopt( $curl , CURLOPT_SSL_VERIFYPEER , false ) ; // 証明書の検証を行わない
curl_setopt( $curl , CURLOPT_RETURNTRANSFER , true ) ; // curl_execの結果を文字列で返す
curl_setopt( $curl , CURLOPT_HTTPHEADER , $context['http']['header'] ) ; // ヘッダー
// if( isset( $context['http']['content'] ) && !empty( $context['http']['content'] ) ) // GETの場合は不要
// {
// curl_setopt( $curl , CURLOPT_POSTFIELDS , $context['http']['content'] ) ; // リクエストボディ
// }
curl_setopt( $curl , CURLOPT_TIMEOUT , 5 ) ; // タイムアウトの秒数
$res1 = curl_exec( $curl ) ;
$res2 = curl_getinfo( $curl ) ;
curl_close( $curl ) ;
// 取得したデータ
$json = substr( $res1, $res2['header_size'] ) ; // 取得したデータ(JSONなど)
$header = substr( $res1, 0, $res2['header_size'] ) ; // レスポンスヘッダー (検証に利用したい場合にどうぞ)
// [cURL]ではなく、[file_get_contents()]を使うには下記の通りです…
// $json = @file_get_contents( $request_url , false , stream_context_create( $context ) ) ;
// JSONをオブジェクトに変換
$obj = json_decode( $json ) ;
// HTML用
$html = '' ;
// タイトル
$html .= '<h1 style="text-align:center; border-bottom:1px solid #555; padding-bottom:12px; margin-bottom:48px; color:#D36015;">account/verify_credentials</h1>' ;
// エラー判定
if( !$json || !$obj )
{
$html .= '<h2>エラー内容</h2>' ;
$html .= '<p>データを取得することができませんでした…。設定を見直して下さい。</p>' ;
}
// 検証用
$html .= '<h2>取得したデータ</h2>' ;
$html .= '<p>下記のデータを取得できました。</p>' ;
$html .= '<h3>ボディ(JSON)</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $json . '</textarea></p>' ;
$html .= '<h3>レスポンスヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $header . '</textarea></p>' ;
// 検証用
$html .= '<h2>リクエストしたデータ</h2>' ;
$html .= '<p>下記内容でリクエストをしました。</p>' ;
$html .= '<h3>URL</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $context['http']['method'] . ' ' . $request_url . '</textarea></p>' ;
$html .= '<h3>ヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . implode( "\r\n" , $context['http']['header'] ) . '</textarea></p>' ;
// フッター
$html .= '<small style="display:block; border-top:1px solid #555; padding-top:12px; margin-top:72px; text-align:center; font-weight:700;">プログラムの説明: <a href="https://syncer.jp/twitter-api-matome/get/account/verify_credentials" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;
?>
サンプルプログラムをこちらからダウンロードできます。素敵なウェブサービスができたら、ぜひ、教えて下さい。
ファイル一覧
ファイル名をクリックすると内容を確認できます。「Download Zip」をクリックするとファイル一式をダウンロードできます。