Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

flickr::api(3pm) [debian man page]

Flickr::API(3pm)					User Contributed Perl Documentation					  Flickr::API(3pm)

NAME

       Flickr::API - Perl interface to the Flickr API

SYNOPSIS

	 use Flickr::API;

	 my $api = new Flickr::API({'key'    => 'your_api_key',
				    'secret' => 'your_app_secret'});

	 my $response = $api->execute_method('flickr.test.echo', {
		       'foo' => 'bar',
		       'baz' => 'quux',
	       });

       or

	 use Flickr::API;
	 use Flickr::API::Request;

	 my $api = new Flickr::API({'key' => 'your_api_key'});

	 my $request = new Flickr::API::Request({
		       'method' => 'flickr.test.echo',
		       'args' => {},
	       });

	 my $response = $api->execute_request($request);

DESCRIPTION

       A simple interface for using the Flickr API.

       "Flickr::API" is a subclass of LWP::UserAgent, so all of the various proxy, request limits, caching, etc are available.

   METHODS
       "execute_method($method, $args)"
	   Constructs a "Flickr::API::Request" object and executes it, returning a "Flickr::API::Response" object.

       "execute_request($request)"
	   Executes a "Flickr::API::Request" object, returning a "Flickr::API::Response" object. Calls are signed if a secret was specified when
	   creating the "Flickr::API" object.

       "request_auth_url($perms,$frob)"
	   Returns a "URI" object representing the URL that an application must redirect a user to for approving an authentication token.

	   For web-based applications $frob is an optional parameter.

	   Returns undef if a secret was not specified when creating the "Flickr::API" object.

AUTHOR

       Copyright (C) 2004-2005, Cal Henderson, <cal@iamcal.com>

       Auth API patches provided by Aaron Straup Cope

SEE ALSO

       Flickr::API::Request, Flickr::API::Response, XML::Parser::Lite, <http://www.flickr.com/>, <http://www.flickr.com/services/api/>

perl v5.14.2							    2014-07-04							  Flickr::API(3pm)

Check Out this Related Man Page

Flickr::API::Response(3pm)				User Contributed Perl Documentation				Flickr::API::Response(3pm)

NAME

       Flickr::API::Response - A response from the flickr API.

SYNOPSIS

	 use Flickr::API;
	 use Flickr::API::Response;

	 my $api = new Flickr::API({'key' => 'your_api_key'});

	 my $response = $api->execute_method('flickr.test.echo', {
		       'foo' => 'bar',
		       'baz' => 'quux',
	       });

	 print "Success: $response->{success}
";

DESCRIPTION

       This object encapsulates a response from the Flickr API. It's a subclass of "HTTP::Response" with the following additional keys:

	 {
	       'success' => 1,
	       'tree' => XML::Parser::Lite::Tree,
	       'error_code' => 0,
	       'error_message' => '',
	 }

       The "_request" key contains the request object that this response was generated from. This request will be a "Flickr::API::Request" object,
       which is a subclass of "HTTP:Request".

       The "sucess" key contains 1 or 0, indicating whether the request suceeded. If it failed, "error_code" and "error_message" explain what went
       wrong. If it suceeded, "tree" contains an "XML::Parser::Lite::Tree" object of the response XML.

AUTHOR

       Copyright (C) 2004, Cal Henderson, <cal@iamcal.com>

SEE ALSO

       Flickr::API, XML::Parser::Lite

perl v5.14.2							    2008-09-29						Flickr::API::Response(3pm)
Man Page