NAME
WebService::Flattr - An interface to Flattr's social micro-payment API
VERSION
version 0.55
SYNOPSIS
use WebService::Flattr();
my $flattr = WebService::Flattr->new;
my $thing = $flattr->thing_exists("http://www.example.com/")->data;DESCRIPTION
This module provides an interface to the http://flattr.com/ social micropayment system.
Flattr have documented their interface at http://developers.flattr.net/api/.
Currently, this module only implements part of Flattr's interface. Future versions will implement more features.
METHODS
Constructor
new
my $flattr = WebService::Flattr->new();This returns a WebService::Flattr object to call "Request Methods" on.
Request Methods
The following request methods perform actions against Flattr's API. Each method returns a WebService::Flattr::Response object on success and dies on failure.
user_flattrs
Takes a list or hash reference containing the mandatory username argument and zero or more optional arguments.
http://developers.flattr.net/api/resources/flattrs/#list-a-users-flattrs
thing_flattrs
Takes a list or hash reference containing the mandatory id argument and zero or more optional arguments.
http://developers.flattr.net/api/resources/flattrs/#list-a-things-flattrs
things_owned_by
Takes a list or hash reference containing the mandatory username argument and zero or more optional arguments.
http://developers.flattr.net/api/resources/things/#list-a-users-things
get_thing
Takes one argument, the ID of a thing.
http://developers.flattr.net/api/resources/things/#get-a-thing
get_things
Takes a list of IDs of things to retrieve.
http://developers.flattr.net/api/resources/things/#get-multiple-things
thing_exists
Takes one argument, the URL of a thing.
http://developers.flattr.net/api/resources/things/#check-if-a-thing-exists.
search_things
Takes optional arguments either as a list or a hash reference.
http://developers.flattr.net/api/resources/things/#search-things
user
Takes one argument, a string containing a username.
http://developers.flattr.net/api/resources/users/#get-a-user
user_activities
Takes one argument, a string containing a username.
http://developers.flattr.net/api/resources/activities/#list-an-users-activities
categories
Takes no arguments.
http://developers.flattr.net/api/resources/categories/#list-categories
languages
Takes no arguments.
http://developers.flattr.net/api/resources/languages/#list-all-available-languages
rate_limit
Takes no arguments.
http://developers.flattr.net/api/#rate-limiting
SUPPORT
Flattr request that you post questions about their API to StackOverflow. See http://developers.flattr.net/api/questions/ for details.
If you would like help using WebService::Flattr, please post there using the flattr tag as they request and the perl tag also.
BUG REPORTS
Please submit bug reports to https://rt.cpan.org/Public/Dist/Display.html?Name=WebService-Flattr.
If you would like to send patches, please send a git pull request to mailto:bug-WebService-Flattr@rt.cpan.org. Thank you in advance for your help.
SEE ALSO
http://developers.flattr.net/api/
AUTHOR
Tom Hukins