Giter Club home page Giter Club logo

node-vagalume's Introduction

node-vagalume

NPM version Build Status Dependency Status Code Climate Test Coverage

No Vagalume temos a performance como um dos itens mais importantes no desenvolvimento do sistema. Devido a grande quantidade de acessos no site, temos como prioridade o carregamento rápido e escalabilidade da aplicação. Utilizar as funções encontradas na API não devem deixar o seu site mais lento ou gerar problemas de estabilidade em nosso sistema. Nesta documentação devemos abordar as melhores práticas de como fazer requisições de forma assíncrona.

IMPORTANTE: O uso da API é totalmente gratuito, mas é muito importante que o logo e link para a página correspondente no Vagalume estejam presentes. Leia os termos de uso, e verifique se o seu site ou aplicação estão de acordo.

IMPORTANTE: Para usar Vagalume API, é necessário que seu aplicativo tenha credenciais de autorização. Cadastre-se no Vagalume e crie sua chave de API. Esta credencial será requerida a partir do dia 23/11/2015.

Instalação

$ npm install --save vagalume

Como usar

ATENÇÃO: Todos os métodos retornam um Promise.

var Vagalume = require('vagalume');
var api = new Vagalume();

api.getNoticias().then(function (data) {
  // faça o que quiser com o retorno  
});
# creates a browser.js
$ npm run browser

Documentação

getArtista(nome)

Além das letras existem várias informações disponíveis sobre o artista. Dados como quantidade de acessos, posição no ranking, gênero musical, músicas mais acessadas do artista, discografia e muito mais. (ver mais)

getByTrecho(trecho, [limite])

Um dos recursos mais interessantes para buscar letras de músicas é a possibilidade de consultar por trecho. Muitas vezes o usuário não lembra do título da música, por isso, este segmento da API pode retornar as músicas que possúem tal trecho buscado. (ver mais)

getDiscografia(nome)

O Vagalume possui também um banco de dados organizando as discografias (álbuns) de cada artista. Como todas as outras chamadas da API, o retorno é feito por JSON e pode e deve ser feito direto pelo navegador do usuário. (ver mais)

getHotspots()

O Hot Spot é o nome da seção do Vagalume que é atualizada diariamente na home com novidades de clipes, músicas e conteúdo relevante para os usuários site. Milhões de usuários entram no Vagalume diariamente para saber o que há de novo no mundo da música. (ver mais)

getNoticias()

Você pode integrar as chamadas das notícias do Vagalume em seu site. Assim, você poderá oferecer um conteúdo bastante atualizados sobre o que acontece no mundo da música. No código abaixo, mostramos as últimas 20 notícias publicadas com informações para link e imagem. (ver mais)

getImagens()

O Vagalume possui também um banco de imagens organizadas por galerias. Disponibilizadas pelo próprio artista no caso como (Divulgação) ou as que os prórpios usuários enviam (Enviadas pelos usuários). (ver mais)

getRanks()

As informações de ranking no Vagalume são constantemente atualizadas e representam a tendência musical conforme milhões de acessos diários a páginas de letras, artistas, álbuns dentre outros. As informações são bem seccionadas, permitindo uso variado e fornecendo inúmeras possibilidades de aplicação em seu projeto.. (ver mais)

License

MIT © Gabriel Pedro

node-vagalume's People

Contributors

gpedro avatar rdiego26 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

node-vagalume's Issues

Add API Key support

Conforme descrição do projeto:

IMPORTANTE: Para usar Vagalume API, é necessário que seu aplicativo tenha credenciais de autorização. Cadastre-se no Vagalume e crie sua chave de API. Esta credencial será requerida a partir do dia 23/11/2015.

Poderíamos fazer a atualização conforme indica a issue que explica como deve ser o novo padrão nas requisições.

Exemplo no método getNoticias()

PUBLIC.getNoticias = function () {
  return PRIVATE.wwwRequest('/news/index.js?apikey={'+apiKey+'}');
};

Algumas ideias de como receber esse valor:

  1. O método a ser usado podería receber esse valor. Acho que não é a melhor opção
  2. A função Vagalume podería receber esse valor var api = new Vagalume('valor_apiKey'); Acho que essa é a melhor opção

O que acha @gpedro ?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.