apiNG-plugin-facebook is a Facebook Graph API plugin for apiNG.
Information
- Supported apiNG models:
social
,image
,video
,event
- This plugin supports the
get-native-data
parameter - This plugin needs an access token ⚠️
- Used promise library: angular-facebook-api-factory (included in distribution files)
Documentation
- INSTALLATION
- Get file
- Include file
- Add dependency
- Add plugin
- ACCESS TOKEN
- Generate your
access_token
- Insert your
access_token
intoaping-config.js
- Generate your
- USAGE
- Models
- Requests
- Rate limit
1. INSTALLATION
I. Get file
Install via either bower, npm, CDN (jsDelivr) or downloaded files:
bower install apiNG-plugin-facebook --save
npm install aping-plugin-facebook --save
- use CDN file
- download apiNG-plugin-facebook.zip
II. Include file
Include aping-plugin-facebook.min.js
in your apiNG application
<!-- when using bower --> <!-- when using npm --> <!-- when using cdn file --> <!-- when using downloaded files -->
III. Add dependency
Add the module jtt_aping_facebook
as a dependency to your app module:
angular;
IV. Add the plugin
Add the plugin's directive aping-facebook="[]"
to your apiNG directive and configure your requests
2. ACCESS TOKEN
access_token
I. Generate your - Login on developers.facebook.com
- Create an new app
- Choose website/webapp
- Open Graph API Explorer
- Press on
Graph API Explorer
dropdown button - Choose your app
- Press on
Get Token
dropdown buton - Choose
Get App Token
- Copy generated
access_token
- Press on
access_token
into aping-config.js
II. Insert your Create and open js/apiNG/aping-config.js
in your application folder. It should be look like this snippet:
angular;
⚠️ Replace <YOUR_FACEBOOK_TOKEN>
with your facebook access_token
3. USAGE
I. Models
Supported apiNG models
model | content | support | max items per request |
(native) default items per request |
---|---|---|---|---|
social |
last posts from users wall | full | 100 |
25 |
image |
last images from users wall | full | 100 |
25 |
video |
last videos from users wall | full | 100 |
25 |
event |
last events from users wall | full | 100 |
25 |
support:
- full: the source platform provides a full list with usable results
- partly: the source platfrom provides just partly usable results
II. Requests
Every apiNG plugin expects an array of requests as html attribute.
Requests by Page
parameter | sample | default | description | optional |
---|---|---|---|---|
page |
michaeljackson |
name or id of any facebook page | no | |
items |
0 -100 |
25 |
items per request | yes |
showAvatar |
true |
false |
Use true for show users avatar as image if post has no own image |
yes |
Samples:
[{'page':'muenchen'}, {'page':'Berlin'}, {'page':'Koeln'}]
[{'page':'muenchen', 'items':10}, {'page':'Berlin', 'items':70}]
III. Rate limit
Visit the official API rate limit documentation
Here's how rate limiting on the Facebook Graph API works:
- Rate limiting is done on your Facebook AppId. If your app reaches a rate limit, all calls made for that app will be limited not just on a per-user basis.
- Rate limiting is calculated by taking the number of users your app had the previous day and adding today's new logins. This gives a base number of users that your app has.
- Each app is given an allotment of 200 API calls per user in any given 60 minute window.
Licence
MIT