mirror of
https://github.com/Sarsoo/Spotify.NET.git
synced 2024-12-24 23:16:28 +00:00
61 lines
2.4 KiB
Markdown
61 lines
2.4 KiB
Markdown
SpotifyAPI-NET
|
||
===
|
||
|
||
[![Build status](https://ci.appveyor.com/api/projects/status/mxpjhw3uli4q0yx1?svg=true)](https://ci.appveyor.com/project/JohnnyCrazy/spotifyapi-net)
|
||
[![Gitter](https://img.shields.io/gitter/room/SpotifyAPI-NET/Lobby.svg)](https://gitter.im/SpotifyAPI-NET/Lobby)
|
||
|
||
A Wrapper for Spotify's Web API, written in .NET
|
||
|
||
**Spotify's Web API** ([link](https://developer.spotify.com/web-api/))
|
||
> Based on simple REST principles, our Web API endpoints return metadata in JSON format about artists, albums, and tracks directly from the Spotify catalogue.
|
||
> The API also provides access to user-related data such as playlists and music saved in a “Your Music” library, subject to user’s authorization.
|
||
|
||
**SpotifyAPI.Web** [![Nuget SpotifyAPI.Web](https://badge.fury.io/nu/SpotifyAPI.Web.svg)](https://www.nuget.org/packages/SpotifyAPI.Web/)
|
||
> A wrapper around Spotify's Web API, providing sync and async methods to query all possible endpoints. Results are returned as typed class instances, allowing property-based access.
|
||
|
||
**SpotifyAPI.Web.Auth** [![Nuget SpotifyAPI.Web.Auth](https://badge.fury.io/nu/SpotifyAPI.Web.Auth.svg)](https://www.nuget.org/packages/SpotifyAPI.Web.Auth/)
|
||
> A library providing C# implementations of the 3 supported Authentication modes, including `ImplicitGrantAuth`, `AuthorizationCodeAuth` and `CredentialsAuth`
|
||
|
||
### Docs and Usage
|
||
|
||
More Information, Installation-Instructions, Examples and API-Reference can be found at [github.io/SpotifyAPI-Net/](http://johnnycrazy.github.io/SpotifyAPI-NET/)
|
||
|
||
### NuGet
|
||
You can add the API to your project via [nuget-package](https://www.nuget.org/packages/SpotifyAPI.Web/):
|
||
```
|
||
Install-Package SpotifyAPI.Web
|
||
Install-Package SpotifyAPI.Web.Auth
|
||
|
||
//or
|
||
|
||
Install-Package SpotifyAPI.Web -pre
|
||
Install-Package SpotifyAPI.Web.Auth -pre
|
||
```
|
||
|
||
### Example
|
||
|
||
```c#
|
||
using SpotifyAPI.Web.Enums;
|
||
using SpotifyAPI.Web.Models;
|
||
|
||
public static async void Example()
|
||
{
|
||
SpotifyWebAPI api = new SpotifyWebAPI
|
||
{
|
||
AccessToken = "XX?X?X",
|
||
TokenType = "Bearer"
|
||
};
|
||
|
||
PrivateProfile profile = await api.GetPrivateProfileAsync();
|
||
if(!profile.HasError()) {
|
||
Console.WriteLine(profile.DisplayName);
|
||
}
|
||
}
|
||
```
|
||
|
||
### Donations
|
||
|
||
If you want to support this project or my work in general, you can donate a buck or two via the link below. However, this will be always optional!
|
||
|
||
[![Donate Link](./donate.svg)](https://paypal.me/JohnnyCrazy)
|