API Reference

Getting Started
Methods +
- Friends +
- Upload +
- Channels +
- Media +
  - Media.logHit
  - Media.updateFile
- Users +
  - Users.confirmCredentials
  - Users.register
- Groups +
- Collections +
- System +
- Geo +
- I18n +
- Vhost +
- InstantWinner +
  - InstantWinner.getEntryForToday
- Notifications +
- Game +
  - Game.logAction

Media.getUploadURL

This method provides you with a signed URL that you can then use to upload directly to the Filemobile Amazon bucket where original files are stored, once the upload is complete you must use the media.uploadCompleted method to trigger the system to begin conversion of this file.

The fileData array, must contain type, and filename fields, an example of a valid type would be video/mp4, or image/jpg.

Working PHP Example


    define('APIKEY','');
    define('APIENDPOINT','https://api.newspark.ca/services/json');

    $sourceFilePath="./test.jpg";
    $sourceFileSize=filesize("./test.jpg");
    $sourceContentType='image/jpg';

    $fileData['title']='This is the title of this Test Image';
    $fileData['filename']='test.jpg';
    $fileData['message']='This is a description of the test image.';
    $fileData['type']=$sourceContentType;

    $arguments = array(
        'APIKEY' => APIKEY,
        'method' => 'media.getUploadURL',
        'vhost' => '1640',
        'v2'=>1,
        'fileData' => $fileData,
    );

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_URL, APIENDPOINT);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($arguments));
    curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    $response = curl_exec($ch);
    curl_close($ch);

    $data =json_decode($response,true);

    if($data['status']==1) {
        $destinationUrl = $data['result']['url'];
        $mediaID = $data['result']['id'];

        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $destinationUrl);
        curl_setopt($ch, CURLOPT_PUT, 1);
        $fh_res = fopen($sourceFilePath, 'r');
        curl_setopt($ch, CURLOPT_INFILE, $fh_res);
        curl_setopt($ch, CURLOPT_INFILESIZE, filesize($sourceFilePath));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        $response = curl_exec ($ch);
        fclose($fh_res);
        curl_close($ch);


        $arguments = array( 'APIKEY' => APIKEY, 'method' => 'media.uploadCompleted', 'id' => $mediaID );
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_POST, 1);
        curl_setopt($ch, CURLOPT_URL, APIENDPOINT);
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($arguments));
        curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        $response = curl_exec($ch);
        curl_close($ch);
    }

Syntax

int media.getUploadURL ( int vhost, array fileData, int ttl = 300, int v2 = 0, mixed recaptchaToken = false )

Arguments

Name	Type	Required	Default value	Description
vhost	int	Required	none	The vhost ID.
fileData	array	Required	none	An array with file information.
ttl	int	Optional	300	Time in seconds for URL to be valid
v2	int	Optional	0	Use V2 of service
recaptchaToken	mixed	Optional	false

fileData

fileData is an array that consists of the information that you want to have stored in your media.

Name	Type	Description	Default	Possible Values
title	STRING	The title associated with the text media item.	empty	empty / STRING
message	STRING	The media message to be included with the media item.	empty	STRING
uid	STRING	The UID of the user who created the media item.	1	INT
tags	STRING	A space separated string containing words to be used as tags for the media item.	empty	empty / STRING
filename	STRING	A string that is going to be assigned as the original name of the file.	empty	empty / STRING
extension	STRING	The extension that is going to be set as the original file extension of the text file.	empty / STRING	png,jpeg,mov
channel	INT	The channel ID the media item is going to be uploaded into.	empty	INT (channel ID)
date	YYYY-MM-DD HH:MM:SS	The date and time the media item started to be uploaded.	empty	YYYY-MM-DD HH:MM:SS
url	STRING	The url reference.	empty	empty
metadata	ARRAY	An ARRAY for any additional information that is to be stored with the media item. It is stored as an associated array in this field. NB 1: You have to set the values of the metadata as an array which itself is a value of the 'users' array. NB 2: When retrieving the information about the media using the API (via function Media.fileGetInfo), you do not specify the 'user' key: the data is returned as: metadata['synopsis'] = 'test1	empty	array( 'user'=> Array ( 'synopsis' => 'test1', 'pin' => 'test2' ) )
moderationstatus	INT	The initial moderation status of the media item once it is uploaded into MediaFactory.	0	0,1,2,3,4 OR (unmoderated, accepted, denied, deleted, notdenied, moderated, all)
geo_latitude	NUMBER	The latitude of of where the media item was created. This is usually set in conjunction with Google Maps and the user plotting the pin on the map.	empty	62.86
geo_longitude	NUMBER	The latitude of of where the media item was created. This is usually set in conjunction with Google Maps and the user plotting the pin on the map.	empty	-52.44
parentid	INT	The media ID that is going to be assigned as the parent to this media item. This would be used in conjunction with context to create text comments.	empty	INT
context	STRING	The type of media that is being uploaded.	'generic'	'generic', 'all', 'comment', 'note', 'commentnote', 'genericcomment', 'parent','child'
language	STRING	A 2-letter ISO code associated with the media.	n/a	STRING
visibility	STRING	The visibility of the media item to the public once uploaded into MediaFactory.	'VISIBLE'	'VISIBLE', 'HIDDEN'
groupid	INT or ARRAY	The ID, or array of IDs, of the group that the media item is going to be uploaded into. Note: To specify that the media item should _NOT_ be added to a group, set this value as 0.	empty	9499 or array(9499,9500)

Response

fileData is an array that consists of the information that you want to have stored in your media.

Name	Type	Description
result	INT	The media ID of the newly created media item in MediaFactory.

Sample Response

Code examples

PHP-RPC

$path = 'https://api.newspark.ca/services/php';

// Listing the arguments
$arguments = array(
  'APIKEY' => 'YOURAPIKEY',
  'method' => 'media.getUploadURL',
  'vhost' => '2',
  'fileData' => $fileData,
  'ttl' => $ttl,
  'v2' => $v2,
  'recaptchaToken' => $recaptchaToken
);

// http_build_query basically turns an array into a url-encoded list of variables
$url = $path .'?' . http_build_query($arguments,null,'&');

// get the contents from the specified url
$data = file_get_contents($url);

// transform it back into php data structures
$data = unserialize($data);

// the actual data is stored in $data['result']

print_r($data['result']);

PEAR XMLRPC client

// Include the client
require_once 'XML/RPC.php';

// Create the XMLRPC Client
$client = new XML_RPC_Client('/services/xmlrpc?APIKEY={YOURAPIKEY}', 'api.newspark.ca');

// PEAR's XML-RPC client requires all arguments to wrapped in a special value class
// XML_RPC_encode converts this automatically

$arguments = array(
  XML_RPC_encode('2'),
  XML_RPC_encode($fileData),
  XML_RPC_encode($ttl),
  XML_RPC_encode($v2),
  XML_RPC_encode($recaptchaToken)
);

// Creating an XML-RPC message
$message = new XML_RPC_Message('media.getUploadURL',$arguments);

// Sending the message to the server
$response = $client->send($message);

// We also need to decode the response back to normal PHP types
$response = XML_RPC_decode($response);

print_r($response);

SabreTooth XMLRPC client

// Include the client
require_once 'Sabre/XMLRPC/Client.php';

// Create the XMLRPC Client
$xmlrpc = new Sabre_XMLRPC_Client('https://api.newspark.ca/services/xmlrpc?APIKEY={YOURAPIKEY}');

$arguments = array(
  '2',
  $fileData,
  $ttl,
  $v2,
  $recaptchaToken
);

$data = $xmlrpc->invoke('media.getUploadURL',$arguments);

print_r($data);

Zend XMLRPC client

// Include the client
require_once 'Zend/XmlRpc/Client.php';

// Create the XMLRPC Client
$client = new Zend_XmlRpc_Client('https://api.newspark.ca/services/xmlrpc?APIKEY={YOURAPIKEY}');

$arguments = array(
  '2',
  $fileData,
  $ttl,
  $v2,
  $recaptchaToken
);

$data = $client->call('media.getUploadURL',$arguments);

print_r($data);

Actionscript 2

    /*
     *     In ActionScript 2 remote service calls are done using the RemotingConnector Component.
     *     An instance of the component must exist on the stage and have an instance name.
     *
     *     Results and Faults are handled by addEventListener's and the call parameters are placed inside of an associative array
     *
     *     You must also specify the service class and method names under the appropriate property fields of the component
     */

    var gatewayURL:String = "/services/amf2";
    //Set up service call
    myRemConn_rc.gatewayUrl = gatewayURL;
    myRemConn_rc.serviceName = "media";
    myRemConn_rc.methodName = "getUploadURL";
    myRemConn_rc.params = {2:vhost, fileData:fileData, ttl:ttl, v2:v2, recaptchaToken:recaptchaToken};
    myRemConn_rc.addEventListener("result", widgetResult);
    myRemConn_rc.addEventListener("status", widgetFault);

    //Make the call
    myRemConn_rc.trigger();

    /*
    *  Handles service result.
    */
    function widgetResult(ev:Object){
        //Do stuff
        //Data is returned inside of ev.target.results
        //(i.e. ev.traget.results.description or ev.traget.results.settings.color)
    }

    /*
    *  Handles service fault.
    */
    function widgetFault(ev:Object){
        //Display Error
        trace("Categories Error - " + ev.code + " -  " + ev.data.faultstring);
    }

Actionscript 3

    /*
     *  In ActionScript 3 remote service calls are done using the NetConnection Object.
     *  A Responder Object controls what functions handle successful or failed calls
     *  and any parameters for the call are placed in an array and passed as a parameter
     *  in the NetConnection.call() method.
     */

    var gatewayURL:String = "/services/amf2";
    var parameters:Array = new Array(vhost, fileData, ttl, v2, recaptchaToken);

    var connection:NetConnection = new NetConnection();
    connection.connect(gatewayURL);
    connection.call("media.getUploadURL", new Responder(widgetResult, widgetFault), parameters);


    /*
     *   Handles service result.
     */
    function widgetResult(ev:Object):void{
        //Do stuff
        //Data is returned inside of ev
        //(i.e. ev.description or ev.settings.color)
    }


    /*
    *  Handles service fault.
    */
    function widgetFault(ev:Object):void{
        //Display Error
        error.showError(parentClip, ev.code + " -  " + ev.description, "Please refresh your browser to try again.");
        error.x = (parentClip.width - error.width) / 2;
        error.y = (parentClip.height - error.height) / 2;
    }

REST service example

<%@ Page Language="vb" %>
<%


' REST gateway
dim gateway as string = "http://api.newspark.ca/services/rest/"

' Service + method we're calling.
dim method as string = "media/getUploadURL"

dim apiKey as string = "YOURAPIKEY"

dim url as string = gateway & method & "?APIKEY=" & apiKey &  "&vhost=2" &  "&fileData=" & fileData

' HTTP Client
dim wcHTTPScrape as new System.net.WebClient()

' Opening a stream
dim objInput as System.IO.Stream = wcHTTPScrape.OpenRead(url)

dim objReader as new System.IO.StreamReader ( objInput )

' Reading the entire HTTP response and output it
Response.Write ( objReader.ReadToEnd () )


objReader.Close ()
objInput.Close ()

%>

jQuery JSON

/*
* jQuery post example
*/

function getUploadURL ( fileData, ttl, v2, recaptchaToken ) {

var params = {
    "method" :      'media.getUploadURL',
    "vhost" :       2,
    "fileData" :    fileData,
    "ttl" :         ttl,
    "v2" :          v2,
    "recaptchaToken" : recaptchaToken}

$.post('/services/json',params
,function(response){
    console.log(response);
});

Local API

// Get the Service Mapper

$mapper = Sabre_ServiceMap_Mapper::getMapper();

// Calling the method
$data = $mapper->media->getUploadURL( 2, $fileData, $ttl, $v2, $recaptchaToken );

print_r($data);

0 comments

Be the first to comment on getUploadURL.

Developer Documentation Portal