# Facebook ## Backend classes For Django, choose from these class paths for `AUTHENTICATION_BACKENDS`. For other integrations, use the same class paths in the framework-specific backend setting. | Backend name | Class path | |----------------|---------------------------------------------------| | `facebook` | `social_core.backends.facebook.FacebookOAuth2` | | `facebook-app` | `social_core.backends.facebook.FacebookAppOAuth2` | Python Social Auth provides multiple backends for Facebook authentication: - **FacebookOAuth2** (`social_core.backends.facebook.FacebookOAuth2`) - Standard Facebook OAuth2 authentication - **FacebookAppOAuth2** (`social_core.backends.facebook.FacebookAppOAuth2`) - For Facebook Canvas Applications - **FacebookLimitedLogin** (`social_core.backends.facebook_limited.FacebookLimitedLogin`) - For Facebook Limited Login (iOS SDK) ## Token renewal Facebook OAuth2 and Facebook App renew credentials by exchanging the stored access token with `grant_type=fb_exchange_token`. A stored `refresh_token` is not required for these backends. Use `social.refresh_token(strategy)` for an explicit exchange or `social.get_access_token(strategy)` to exchange when the stored access token has expired. See [Token renewal](oauth.html.md#oauth-token-renewal) for expiry handling and renewal failures. ## OAuth2 Facebook uses OAuth2 for its auth process. Further documentation at [Facebook development resources](http://developers.facebook.com/docs/authentication/): - Register a new application at [Facebook App Creation](https://developers.facebook.com/apps/), don’t use `localhost` as `App Domains` and `Site URL` since Facebook won’t allow them. Use a placeholder like `myapp.com` and define that domain in your `/etc/hosts` or similar file. - Add the Facebook OAuth2 backend to your `AUTHENTICATION_BACKENDS` setting: ```default AUTHENTICATION_BACKENDS = ( ... 'social_core.backends.facebook.FacebookOAuth2', ... ) ``` - fill `App Id` and `App Secret` values in values: ```default SOCIAL_AUTH_FACEBOOK_KEY = '' SOCIAL_AUTH_FACEBOOK_SECRET = '' ``` - Define `SOCIAL_AUTH_FACEBOOK_SCOPE` to get extra permissions from facebook. Email is not sent by default, to get it, you must request the `email` permission: ```default SOCIAL_AUTH_FACEBOOK_SCOPE = ['email'] ``` - Define `SOCIAL_AUTH_FACEBOOK_PROFILE_EXTRA_PARAMS` to pass extra parameters to [https://graph.facebook.com/me](https://graph.facebook.com/me) when gathering the user profile data (you need to explicitly ask for fields like `email` using `fields` key): ```default SOCIAL_AUTH_FACEBOOK_PROFILE_EXTRA_PARAMS = { 'locale': 'ru_RU', 'fields': 'id, name, email, age_range' } ``` If you define a redirect URL in Facebook setup page, be sure to not define [http://127.0.0.1:8000](http://127.0.0.1:8000) or [http://localhost:8000](http://localhost:8000) because it won’t work when testing. Instead I define [http://myapp.com](http://myapp.com) and setup a mapping on `/etc/hosts`. Currently the backend uses Facebook API version 18.0 by default, but this can be overridden by the following setting: ```default SOCIAL_AUTH_FACEBOOK_API_VERSION = '19.0' ``` #### NOTE If you’re using Facebook Graph API v3.0 or later, be aware that several parameters have been deprecated: - The `display` parameter (e.g., `{'display': 'touch'}`) is no longer supported. Facebook now automatically detects mobile devices based on the user agent. - Make sure to check Facebook’s [Graph API Changelog](https://developers.facebook.com/docs/graph-api/changelog) for other deprecated features when upgrading to newer API versions. ## Canvas Application If you need to perform authentication from Facebook Canvas application: - Create your canvas application at [http://developers.facebook.com/apps](http://developers.facebook.com/apps) - In Facebook application settings specify your canvas URL `mysite.com/fb` (current default) - Add the Facebook Canvas Application backend to your `AUTHENTICATION_BACKENDS` setting: ```default AUTHENTICATION_BACKENDS = ( ... 'social_core.backends.facebook.FacebookAppOAuth2', ... ) ``` - Setup your Python Social Auth settings and your application namespace: ```default SOCIAL_AUTH_FACEBOOK_APP_KEY = '' SOCIAL_AUTH_FACEBOOK_APP_SECRET = '' SOCIAL_AUTH_FACEBOOK_APP_NAMESPACE = '' ``` - Launch your testing server on port 80 (use sudo or nginx or apache) for browser to be able to load it when Facebook calls canvas URL - Open your Facebook page via [http://apps.facebook.com/app_namespace](http://apps.facebook.com/app_namespace) or better via [http://www.facebook.com/pages/user-name/user-id?sk=app_app-id](http://www.facebook.com/pages/user-name/user-id?sk=app_app-id) - After that you will see this page in a right way and will able to connect to application and login automatically after connection - Provide a template to be rendered, it must have this JavaScript snippet (or similar) in it: ```default ``` More info on the topic at [Facebook Canvas Application Authentication](http://www.ikrvss.ru/2011/09/22/django-social-auth-and-facebook-canvas-applications/).