60 lines
2.8 KiB
Markdown
60 lines
2.8 KiB
Markdown
**Master:** [](https://ci.appveyor.com/project/tparnell8/untappd-net/branch/master)
|
|
**Release:**[](https://ci.appveyor.com/project/tparnell8/untappd-net/branch/Release)
|
|
**Code Coverage:** [](https://coveralls.io/r/tparnell8/Untappd.Net?branch=master)
|
|
|
|
**Kanban** [](https://waffle.io/tparnell8/untappd.net)
|
|
|
|
**Tips:** [](https://gratipay.com/TommyParnell)
|
|
**Chat:** [](https://gitter.im/tparnell8/Untappd.Net?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
# Untappd.Net
|
|
|
|
This is a c# wrapper around the Untappd API. This can be downloaded via [Nuget](https://www.nuget.org/packages/Untappd.Net/), or the [backup feed](https://www.myget.org/F/untappd-net/api/v2).
|
|
|
|
## API Coverage
|
|
|
|
Current both Authenticated and Unauthenticated requests.
|
|
|
|
More info: https://untappd.com/api/docs
|
|
|
|
For Authenticated requests, you should already have a valid token, provided via OAuth authentication.
|
|
|
|
Such authentication can be achieved using Owin OAuth Providers for ASP.NET Web Applications, which already have an Untappd provider.
|
|
|
|
More info: https://github.com/RockstarLabs/OwinOAuthProviders
|
|
|
|
## How do I use?
|
|
|
|
* Request an [API Key](https://untappd.com/api/register?register=new)
|
|
* You should be able to make a repository and call the get method with the thing you are requesting.
|
|
|
|
Note: Additional parameters can be passed into the Get Method with an IDictionary.
|
|
|
|
```csharp
|
|
|
|
var ts = new UnAuthenticatedUntappdCredentials("key", "secret");
|
|
var t = new Repository().Get<UserDistinctBeers>(ts, "tparnell");
|
|
var t = new Repository().Get<BeerInfo>(ts, "BeerIdHere");
|
|
|
|
```
|
|
|
|
For Authenticated requests:
|
|
|
|
```csharp
|
|
|
|
var ts = new AuthenticatedUntappdCredentials("token", "key", "secret");
|
|
var t = new Repository().Get<ActivityFeed>(ts);
|
|
|
|
```
|
|
|
|
## Contributing
|
|
|
|
* Everyone is welcome to contribute!
|
|
* If you are looking for something to do, look at the issues.
|
|
* There are no special instructions, submit pull requests against the master branch.
|
|
* Releases to nuget occur on successful release branch builds.
|
|
* The only reason I do not publish on master, is because sometimes commits can just contain readme files, or unit tests changes that do not affect the nuget package
|
|
|
|
Current contributors:
|
|
* Tommy James Parnell (https://github.com/tparnell8)
|
|
* Rodrigo P Reis (https://github.com/rodkings)
|