Awesome
apiNG-plugin-tumblr is a Tumblr API plugin for apiNG.
Information
- Supported apiNG models:
social
,image
,video
- This plugin supports the
get-native-data
parameter - This plugin needs an api key :warning:
- Used promise library: angular-tumblr-api-factory (included in distribution files)
Documentation
- INSTALLATION
- Get file
- Include file
- Add dependency
- Add plugin
- API KEY
- Generate your
api_key
- Insert your
api_key
intoaping-config.js
- Generate your
- USAGE
- Models
- Requests
1. INSTALLATION
I. Get file
You can choose your preferred method of installation:
Install via either bower, npm, CDN (jsDelivr) or downloaded files:
bower install apiNG-plugin-tumblr --save
npm install aping-plugin-tumblr --save
- use CDN file
- download apiNG-plugin-tumblr.zip
II. Include file
Include aping-plugin-tumblr.min.js
in your apiNG application
<!-- when using bower -->
<script src="bower_components/apiNG-plugin-tumblr/dist/aping-plugin-tumblr.min.js"></script>
<!-- when using npm -->
<script src="node_modules/aping-plugin-tumblr/dist/aping-plugin-tumblr.min.js"></script>
<!-- when using cdn file -->
<script src="//cdn.jsdelivr.net/npm/aping-plugin-tumblr@latest/dist/aping-plugin-tumblr.min.js"></script>
<!-- when using downloaded files -->
<script src="aping-plugin-tumblr.min.js"></script>
III. Add dependency
Add the module jtt_aping_tumblr
as a dependency to your app module:
angular.module('app', ['jtt_aping', 'jtt_aping_tumblr']);
IV. Add the plugin
Add the plugin's directive aping-tumblr="[]"
to your apiNG directive and configure your requests
<aping
template-url="templates/social.html"
model="social"
items="20"
aping-tumblr="[{'page':'camaradakalderra'}]">
</aping>
2. API KEY
I. Generate your api_key
coming soon ...
II. Insert your api_key
into aping-config.js
Create and open js/apiNG/aping-config.js
in your application folder. It should be look like this snippet:
angular.module('jtt_aping').config(['$provide', function ($provide) {
$provide.value("apingDefaultSettings", {
apingApiKeys : {
'tumblr': [
{'api_key':'<YOUR_TUMBLR_API_KEY>'},
]
//...
}
});
}]);
:warning: Replace <YOUR_TUMBLR_API_KEY>
with your api_key
3. USAGE
I. Models
Supported apiNG models
model | content | support | max items<br>per request | (native) default items<br>per request |
---|---|---|---|---|
social | text, links, images, videos, audio | full | 20 | 20 |
video | videos | full | 20 | 20 |
image | images | full | 20 | 20 |
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 | camaradakalderra | The standard or custom blog hostname | no | |
items | 15 | 20 | Items per request (0 -20 ) | yes |
tag | soccer | Limits the response to posts with the specified tag | yes |
Sample requests:
[{'page':'namikamusik'}]
[{'page':'camaradakalderra', 'tag':'soccer', 'items':14}]
Licence
MIT