js-spotify-wrapper

Spotify Wrapper

A uma aplicação que utiliza a Spotify Web API

Suporte aos Browsers

Essa biblioteca utiliza o Fetch API. E esta API é suportada nos seguintes browsers.

39+ ✔	42+ ✔	29+ ✔	10.1+ ✔	Nope ✘

Dependências

Essa biblioteca depende do fetch para fazer requisições na API Spotify. Para ambientes que não suportam a tecnologia fetch, você precisa prover um polyfill para o navegador ou polyfill para o Node.

Instalação

$ npm install js-spotify-wrapper --save

Como utilizar

ES6

// para importar a biblioteca
import SpotifyWrapper from 'js-spotify-wrapper';

CommonJS

var spotifyWrapper = require('js-spotify-wrapper');

UMD in Browser

<!-- para importar a versão não-minificada -->
<script src="spotify-wrapper.umd.js"></script>

<!-- para importar a versão minificada -->
<script src="spotify-wrapper.umd.min.js"></script>

Após isto, a API ficará disponível pelo nome de SpotifyWrapper. Para utilizar a API é necessário um token que pode ser gerado aqui. O token expira a cada duas horas. Como mostra o exemplo:

const spotify = new SpotifyWrapper({
  token: 'Seu token gerado aqui'
});
const albums = spotify.search.searchAlbums('Artista escolhido');

Metódos

Confira os métodos que a biblioteca disponibiliza

Search

Os metódos search ficam disponíveis pelo atributo 'search'.

const spotify = new SpotifyWrapper({
  token: 'Seu token gerado aqui'
});
const albums = spotify.search.metodoEscolhido();

searchAlbums(query)

Pesquise por Albums. Teste em: Spotify Web Console com o tipo definido como album.

Argumentos

Argumento	Tipo	Opções
query	string	'Pesquise qualquer coisa'

Exemplo

searchAlbums('Veil of Maya')
  .then(data => {
    // faça o que quiser com o resultado
  })

searchArtists(query)

Pesquise por Artistas. Teste em: Spotify Web Console com o tipo definido como artist.

Argumentos

Argumento	Tipo	Opções
query	string	'Pesquise qualquer coisa'

Exemplo

searchArtists('Veil of Maya')
  .then(data => {
    // faça o que quiser com o resultado
  })

searchTracks(query)

Pesquise por Faixas. Teste em: Spotify Web Console com o tipo definido como track.

Argumentos

Argumento	Tipo	Opções
query	string	'Pesquise qualquer coisa'

Exemplo

searchTracks('Veil of Maya')
  .then(data => {
    // faça o que quiser com o resultado
  })

searchPlaylists(query)

Pesquise por Playlists. Teste em: Spotify Web Console com o tipo definido como playlist.

Argumentos

Argumento	Tipo	Opções
query	string	'Pesquise qualquer coisa'

Exemplo

searchPlaylists('Veil of Maya')
  .then(data => {
    // faça o que quiser com o resultado
  })

Albums

Os metódos album ficam disponíveis pelo atributo 'album'.

const spotify = new SpotifyWrapper({
  token: 'Seu token gerado aqui'
});
const albums = spotify.album.metodoEscolhido();

getAlbum(id)

Retorne um album especifico informando o id. Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
id	string	'Id especifico'

Exemplo

getAlbum('4aawyAB9vmqN3uQ7FjRGTy')
  .then(data => {
    // faça o que quiser com resultado
  })

getAlbums(ids)

Retorne vários albums especificos informando seus id's Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
ids	Array de Strings	['id1', 'id2']

Exemplo

getAlbum(['4aawyAB9vmqN3uQ7FjRGTy', '1A2GTWGtFfWp7KSQTwWOyo'])
  .then(data => {
    // faça o que quiser com o resultado
  })

getAlbumTracks(id)

Retorne a faixas de um album especifico informando o id. Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
id	string	'Id especifico'

Exemplo

getAlbum('4aawyAB9vmqN3uQ7FjRGTy')
  .then(data => {
    // faça o que quiser com o resultado
  })

Artists

Os metódos de artist ficam disponíveis pelo atributo 'artist'.

const spotify = new SpotifyWrapper({
  token: 'Seu token gerado aqui'
});
const artists = spotify.artist.metodoEscolhido();

getArtist(id)

Retorne um artista especifico informando o id. Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
id	string	'Id especifico'

Exemplo

getArtist('0TnOYISbd1XYRBk9myaseg')
  .then(data => {
    // faça o que quiser com resultado
  })

getArtists(ids)

Retorne vários artistas especificos informando seus id's. Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
ids	Array de Strings	['id1', 'id2']

Exemplo

getArtists(['2CIMQHirSU0MQqyYHq0eOx','57dN52uHvrHOxijzpIgu3E','1vCWHaC5f2uS3yhpwWbIA6'])
  .then(data => {
    // faça o que quiser com o resultado
  })

getArtistAlbums(id, tipo)

Retorne todos os albums de um determinado artista informando o id. É possível escolher o tipo de album que deseja receber. Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
id	string	'Id especifico'
tipo	string	'Tipo de dado (single, album, appears_on, compilation)'

Exemplo

getArtistAlbums('0TnOYISbd1XYRBk9myaseg', 'single')
  .then(data => {
    // faça o que quiser com resultado
  })

getArtistTopTracks(id)

Retorne o top 10 de um determinado artista informando o id. Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
id	string	'Id especifico'

Exemplo

getArtistTopTracks('0TnOYISbd1XYRBk9myaseg')
  .then(data => {
    // faça o que quiser com resultado
  })

getArtistRelated(id)

Retorne os artistas relacionados. Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
id	string	'Id especifico'

Exemplo

getArtistRelated('0TnOYISbd1XYRBk9myaseg')
  .then(data => {
    // faça o que quiser com resultado
  })

Contribuições

Por favor leia CONTRIBUTING.md para detalhes sobre nosso código de conduta.

Versionamento

Nós usamos SemVer para o versionamento. Para ver as versões disponíveis, visite as tags deste repositorio.

Autores

Darlan Caruso

Veja também a lista de contribuidores que participaram deste projeto.

Licença

Este projeto foi licenciado sobre o MIT - veja o arquivo LICENSE.md para mais detalhes.