NAME
Net::Facebook::Oauth2 - a simple Perl wrapper around Facebook OAuth v2.0 protocol
SYNOPSIS
Somewhere in your application's login process:
use Net::Facebook::Oauth2;
my $fb = Net::Facebook::Oauth2->new(
application_id => 'your_application_id',
application_secret => 'your_application_secret',
callback => 'http://yourdomain.com/facebook/callback'
);
# get the authorization URL for your application
my $url = $fb->get_authorization_url(
scope => [ 'public_profile', 'email', 'offline_access', 'publish_stream' ],
display => 'page'
);
Now redirect the user to this $url
.
Once the user authorizes your application, Facebook will send him/her back to your application, on the callback
link provided above.
Inside that callback route, use the verifier code parameter that Facebook sends to get the access token:
# param() below is a bogus function. Use whatever your web framework
# provides (e.g. $c->req->param('code'), $cgi->param('code'), etc)
my $code = param('code');
my $access_token = $fb->get_access_token(code => $code);
If you got so far, your user is logged! Save this access token in your database or session.
Later on you can use it to communicate with Facebook on behalf of this user:
my $fb = Net::Facebook::Oauth2->new(
access_token => $access_token
);
my $info = $fb->get(
'https://graph.facebook.com/v2.2/me' # Facebook API URL
);
print $info->as_json;
DESCRIPTION
Net::Facebook::Oauth2 gives you a way to simply access FaceBook Oauth 2.0 protocol
For more information please see example folder shipped with this Module
SEE ALSO
For more information about Facebook Oauth 2.0 API
Please Check http://developers.facebook.com/docs/
get/post Facebook Graph API http://developers.facebook.com/docs/api
USAGE
Net::Facebook::Oauth->new( %args )
Pass args as hash. %args
are:
application_id
Your application id as you get from facebook developers platform when you register your application
application_secret
Your application secret id as you get from facebook developers platform when you register your application
$fb->get_authorization_url( %args )
Return an Authorization URL for your application, once you receive this URL redirect user there in order to authorize your application
scope
['offline_access','publish_stream',...]
Array of Extended permissions as described by facebook Oauth2.0 API you can get more information about scope/Extended Permission from
http://developers.facebook.com/docs/authentication/permissions
Please note that requesting information other than
public_profile
,email
anduser_friends
will require your app to be reviewed by Facebook!callback
callback URL, where facebook will send users after they authorize your application
display
How to display Facebook Authorization page
page
This will display facebook authorization page as full page
popup
This option is useful if you want to popup authorization page as this option tell facebook to reduce the size of the authorization page
wab
From the name, for wab and mobile applications this option is the best facebook authorization page will fit there :)
$fb->get_access_token( %args )
Returns access_token string One arg to pass
code
This is the verifier code that facebook send back to your callback URL once user authorize your app, you need to capture this code and pass to this method in order to get access_token
Verifier code will be presented with your callback URL as code parameter as the following
http://your-call-back-url.com?code=234er7y6fdgjdssgfsd...
When access token is returned you need to save it in a secure place in order to use it later in your application
$fb->get( $url,$args )
Send get request to facebook and returns response back from facebook
url
Facebook Graph API URL as string
$args
hashref of parameters to be sent with graph API URL if required
The response returned can be formatted as the following
$response>as_json
Returns response as json object
$response>as_hash
Returns response as perl hashref
For more information about facebook grapg API, please check http://developers.facebook.com/docs/api
$fb->post( $url,$args )
Send post request to facebook API, usually to post something
url
Facebook Graph API URL as string
$args
hashref of parameters to be sent with graph API URL
For more information about facebook grapg API, please check http://developers.facebook.com/docs/api
AUTHOR
Mahmoud A. Mehyar, <mamod.mehyar@gmail.com>
CONTRIBUTORS
Big Thanks To
Takatsugu Shigeta @comewalk
Breno G. de Oliveira @garu
squinker @squinker
Valcho Nedelchev @valchonedelchev
COPYRIGHT AND LICENSE
Copyright (C) 2012-2015 by Mahmoud A. Mehyar
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.1 or, at your option, any later version of Perl 5 you may have available.