Home

Awesome

apiNG

Join the chat at https://gitter.im/JohnnyTheTank/apiNG npm version Bower version

apiNG-plugin-tumblr is a Tumblr API plugin for apiNG.

Information

Documentation

  1. INSTALLATION
    1. Get file
    2. Include file
    3. Add dependency
    4. Add plugin
  2. API KEY
    1. Generate your api_key
    2. Insert your api_key into aping-config.js
  3. USAGE
    1. Models
    2. Requests

1. INSTALLATION

I. Get file

You can choose your preferred method of installation:

Install via either bower, npm, CDN (jsDelivr) or downloaded files:

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

modelcontentsupportmax items<br>per request(native) default items<br>per request
socialtext, links, images, videos, audiofull2020
videovideosfull2020
imageimagesfull2020

support:

II. Requests

Every apiNG plugin expects an array of requests as html attribute.

Requests by Page

parametersampledefaultdescriptionoptional
pagecamaradakalderraThe standard or custom blog hostnameno
items1520Items per request (0-20)yes
tagsoccerLimits the response to posts with the specified tagyes

Sample requests:

Licence

MIT