Pikeo Perl API

Perl interface to pikeo.com rest API

History

NAME

Pikeo::API - High-level OO interface to pikeo.com API!

VERSION

Version 0.5

SYNOPSIS

    use Pikeo::API;
    use Pikeo::API::Photos;

    # create an API object to maintain you session
    # trough out the diferent calls
    my $api = Pikeo::API->new({secret=>'asd', key=>'asdas'});

    # Create the Photos facade
    my $photos = Pikeo::API::Photos->new({ api => $api });
    # Search for photos
    $photos_searched = $photos->search({text=>'shozu'});

DESCRIPTION

This package provides a OO interface to the pikeo.com API.

Using the pikeo REST API, this distribution provides an high-level interface to traverse the pikeo objects.

To use this module you need to have a valid API key.

This module, Pikeo::API, provides the object that olds the api request definitions such as api_key, user agent configuration and credentials for de authenticaded calls.

You must instantiate a Pikeo::API object in order to use the facade module that abstract the photos, albums, etc.

All the facade modules receive an Pikeo::API object as a mandatory argument for their constructors.

FACADE MODULES

  • Pikeo::API::Photos Search and retrieve photos.
  • Pikeo::API::People Search and retrieve users/profiles.
  • Pikeo::API::User::Logged Provides access to the private methods for your user. You must be logged in.

FUNCTIONS

CONSTRUCTORS

new( \%args )

Returns a Pikeo::API object.

Required args are:

  • api_key
    Your api key
  • api_secret
    Optional args are:
  • username
    Username to login
  • password
    Password for the logged user

INSTANCE METHODS

login(\%args)

Authenticate and login the user.

AUTHOR

Bruno Tavares, {{<bmavt at cpan.org>}}

BUGS

Please report any bugs or feature requests to {{bug-pikeo-api at rt.cpan.org}}, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pikeo-API. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Pikeo::API

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2008 Bruno Tavares, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Also available in: HTML TXT