Home

Awesome

apiNG

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

apiNG-plugin-bandsintown is a BandsInTown v2 API plugin for apiNG.

Information

Documentation

  1. INSTALLATION
    1. Get file
    2. Include file
    3. Add dependency
    4. Add plugin
  2. API KEY
  3. USAGE
    1. Models
    2. Requests

1. INSTALLATION

I. Get file

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

II. Include file

Include aping-plugin-bandsintown.min.js in your apiNG application

<!-- when using bower -->
<script src="bower_components/apiNG-plugin-bandsintown/dist/aping-plugin-bandsintown.min.js"></script>

<!-- when using npm -->
<script src="node_modules/aping-plugin-bandsintown/dist/aping-plugin-bandsintown.min.js"></script>

<!-- when using cdn file -->
<script src="//cdn.jsdelivr.net/aping.plugin-bandsintown/latest/aping-plugin-bandsintown.min.js"></script>

<!-- when using downloaded files -->
<script src="aping-plugin-bandsintown.min.js"></script>

III. Add dependency

Add the module jtt_aping_bandsintown as a dependency to your app module:

angular.module('app', ['jtt_aping', 'jtt_aping_bandsintown']);

IV. Add plugin

Add the plugin's directive aping-bandsintown="[]" to your apiNG directive and configure your requests

<aping
    template-url="templates/event.html"
    model="event"
    items="20"
    aping-bandsintown="[{'artist':'Prinz Pi'}]">
</aping>

2. API KEY

Official BandsInTown Authentication Docs:

The application ID can be anything, but should be a word that describes your application or company.

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 : {
            bandsintown: [
                {'app_id':'<YOUR_BANDSINTOWN_APP_ID>'}
            ],
            //...
        }
    });
}]);

:warning: Replace <YOUR_BANDSINTOWN_APP_ID> with a word that describes your application or company

3. USAGE

I. Models

Supported apiNG models

modelcontent
eventconcerts, tours, shows

II. Requests

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

Requests by Artist

parametersampledefaultdescriptionoptional
artistMetallicaArtist name (url escaped*), mbid_<id> (MusicBrainz ID), fbid_<id> (Facebook Page ID)no
artist_idmbid_65f4f0c5-ef9e-490c-aee3-909e7ae6b2ab(fallback) artist id, mbid_<id> (MusicBrainz ID), fbid_<id> (Facebook Page ID)yes
showAvatartruefalseUse true for show artists imageyes
items20Items per request (0-n)yes
dateallupcomingvalid values: yyyy-mm-dd, upcoming, allyes
start_date2016-01-31Start date. format: yyyy-mm-dd. Needs end_dateyes
end_date2016-04-15End date. format: yyyy-mm-dd. Needs start_dateyes
locationmunich,germanyLocation to search city,state (US or CA), city,countryyes
lat-13.163333Latitude of the location. Needs lngyes
lng-72.545556Longitude of the location. Needs latyes
distance1025Number (miles) of radius from location (or coordinates)yes
recommendedtruefalseReturns recommended events for a single artist matching search criteriayes
excludetruefalseIf true, the response will only include matching events for artists similar to the specified artist. if false, the response may also include matching events for the specified artist.yes

Sample requests:

Licence

MIT