SYNCER

SYNCER

POST media/upload - 画像をアップロードする

9件

公開日:

media/upload(POSTメソッド)は、メディアファイル(画像)をアップロードするエンドポイントです。返り値のJSONで、メディアIDを取得でき、そのIDを指定することで、例えばツイートに画像を添付して投稿できたりします。画像は約1日で自動的に削除されます。

POST media/upload
POST media/upload
Twitterの公式リファレンス(英語)。media/uploadに関する説明があります。

リソース

エンドポイント

POST https://upload.twitter.com/1.1/media/upload.json

条件

項目ユーザー認証アプリケーション認証
利用●×
パーミッションRead and Write-
レートリミットあり(Twitterルールを適用)-

パラメータ

media

画像の、生のバイナリデータを指定する。

media_data

画像の、base64エンコードしたデータを指定する。

additional_owners

指定例: 1528352858,2905085521

基本的にアップロードしたユーザー以外は、メディアIDを取り扱えない。しかし、この値にユーザーIDを指定することで、そのユーザーもメディアIDを取り扱えるようになる。複数指定する場合はカンマ(,)で区切る。

レスポンス

アクセストークン(OAuth1.0)でリクエストをした場合の例です。

リクエストURL

https://upload.twitter.com/1.1/media/upload.json

リクエストヘッダー

Authorization: OAuth oauth_consumer_key=:consumer_key,oauth_nonce=0.91309200+1484896313,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484896313,oauth_token=:access_token,oauth_version=1.0,oauth_signature=4OEu961iNKTVy5Ntk7pDSpkq7is%3D

Content-Type: multipart/form-data; boundary= s-y-n-c-e-r---------------15ffb88d5e79a4d87b7103b4a4eca9fa

リクエストボディ

--s-y-n-c-e-r---------------15ffb88d5e79a4d87b7103b4a4eca9fa
Content-Disposition: form-data; name="media"; 

����JFIF��C		
		



! #'2*#%/%+;,/35888!*=A<6A2785��C	



5$$55555555555555555
--s-y-n-c-e-r---------------15ffb88d5e79a4d87b7103b4a4eca9fa
Content-Disposition: form-data; name="additional_owners"

1528352858,2905085521
--s-y-n-c-e-r---------------15ffb88d5e79a4d87b7103b4a4eca9fa--

レスポンスボディ (JSON)

JSON

{"media_id":822340860096323584,"media_id_string":"822340860096323584","size":2555,"expires_after_secs":86400,"image":{"image_type":"image\/jpeg","w":100,"h":100}}

レスポンスヘッダー

HTTP/1.1 100 Continue

HTTP/1.1 200 OK
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0
content-disposition: attachment; filename=json.json
content-length: 162
content-type: application/json;charset=utf-8
date: Fri, 20 Jan 2017 07:11:54 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Fri, 20 Jan 2017 07:11:54 GMT
pragma: no-cache
server: tsa_m
set-cookie: lang=ja; Path=/
set-cookie: guest_id=v1%3A148489631404834290; Domain=.twitter.com; Path=/; Expires=Sun, 20-Jan-2019 07:11:54 UTC
status: 200 OK
strict-transport-security: max-age=631138519
vary: Origin
x-access-level: read-write
x-connection-hash: b6b6605eeb6efb547d4983870f1e9338
x-frame-options: SAMEORIGIN
x-rate-limit-limit: 415
x-rate-limit-remaining: 414
x-rate-limit-reset: 1484899914
x-response-time: 422
x-transaction: 00a87ed50038af76
x-tsa-request-body-time: 2
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block

デモ

media/uploadのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(書込権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。

media
アップロードする画像
media_data

このパラメータの指定は、デモでは非対応です。

additional_owners

認証方法 (ユーザー認証のみ)

/

サンプルコード

media/uploadのエンドポイントを利用するためのサンプルプログラムです。各種トークンの情報をセットしてからPHPで起動して下さい。リクエストに成功すると、$jsonという変数に目的のデータが代入されます。このデータを整形するなり保存するなり、活用して下さい。

アクセストークン

PHP (OAuth1.0)

<?php
/**************************************************

	[POST media/upload]のお試しプログラム

	認証方式: アクセストークン

	配布: SYNCER
	公式ドキュメント: https://dev.twitter.com/rest/reference/post/media/upload
	日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/POST/media/upload/

**************************************************/

	// 設定
	$api_key = '' ;		// APIキー
	$api_secret = '' ;		// APIシークレット
	$access_token = '' ;		// アクセストークン
	$access_token_secret = '' ;		// アクセストークンシークレット
	$request_url = 'https://upload.twitter.com/1.1/media/upload.json' ;		// エンドポイント
	$request_method = 'POST' ;

	// パラメータA (オプション)
	$params_a = array(
		"media" => file_get_contents( "./image.png" ),
//		"media_data" => "",
//		"additional_owners" => "1528352858,2905085521",
	) ;

	// キーを作成する (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' ,
	) ;

	// リクエストURLにより、メディアを指定するパラメータが違う
	switch( $request_url ) {
		case( 'https://api.twitter.com/1.1/account/update_profile_background_image.json' ) :
		case( 'https://api.twitter.com/1.1/account/update_profile_image.json' ) :
			$media_param = 'image' ;
		break ;

		case( 'https://api.twitter.com/1.1/account/update_profile_banner.json' ) :
			$media_param = 'banner' ;
		break ;

		case( 'https://upload.twitter.com/1.1/media/upload.json' ) :
			$media_param = ( isset($params_a['media']) && !empty($params_a['media']) ) ? 'media' : 'media_data' ;
		break ;
	}

	// イメージデータの取得
	$media_data = ( isset($params_a[ $media_param ]) && $params_a[ $media_param ] ) ? $params_a[ $media_param ] : '' ;

	// 署名の材料から、メディアデータを除外する
	if( isset( $params_a[ $media_param ] ) ) unset( $params_a[ $media_param ] ) ;

	// バウンダリーの定義
	$boundary = 's-y-n-c-e-r---------------' . md5( mt_rand() ) ;

	// POSTフィールドの作成 (まずはメディアのパラメータ)
	$request_body = '' ;
	$request_body .= '--' . $boundary . "\r\n" ;
	$request_body .= 'Content-Disposition: form-data; name="' . $media_param . '"; ' ;
//	$request_body .= 'filename="' . time() . '"' ;	// [filename]は指定不要なので、おサボり…
	$request_body .= "\r\n" ;
//	[Content-Type]と[Content-Transfer-Encoding]は指定不要なので、おサボり…
//	$mimetype = 〜	//Mime/Typeを調べる処理
//	$request_body .= "Content-Type: " . $mimetype . "\r\n" ;
//	$request_body .= "Content-Transfer-Encoding: \r\n" ;
	$request_body .= "\r\n" . $media_data . "\r\n" ;

	// POSTフィールドの作成 (その他のオプションパラメータ)
	foreach( $params_a as $key => $value ) {
		$request_body .= '--' . $boundary . "\r\n" ;
		$request_body .= 'Content-Disposition: form-data; name="' . $key . '"' . "\r\n\r\n" ;
		$request_body .= $value . "\r\n" ;
	}

	// リクエストボディの作成
	$request_body .= '--' . $boundary . '--' . "\r\n\r\n" ;

	// リクエストヘッダーの作成
	$request_header = "Content-Type: multipart/form-data; boundary=" . $boundary ;

	// パラメータAとパラメータBを合成してパラメータCを作る → ×
//	$params_c = array_merge( $params_a , $params_b ) ;
	$params_c = $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 ,
				'Content-Type: multipart/form-data; boundary= ' . $boundary ,
			) ,
			'content' => $request_body ,
		) ,
	) ;

	// 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'] ) ;			// ヘッダー
	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;">POST media/upload</h1>' ;

	// 検証用
	$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 .= 	'<h3>ボディ</h3>' ;
	$html .= 	'<p><textarea style="width:80%" rows="8">' . ( isset($context['http']['content']) ? $context['http']['content'] : "" ) . '</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/Web/API/Twitter/REST_API/POST/media/upload/" target="_blank">SYNCER</a></small>' ;

	// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
	echo $html ;