https://github.com/veleek/sesame-net
Sesame API for .NET
https://github.com/veleek/sesame-net
api api-client csharp sesame
Last synced: 9 months ago
JSON representation
Sesame API for .NET
- Host: GitHub
- URL: https://github.com/veleek/sesame-net
- Owner: veleek
- License: mit
- Created: 2017-06-04T07:51:52.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-30T04:52:25.000Z (almost 8 years ago)
- Last Synced: 2025-08-16T15:49:17.777Z (11 months ago)
- Topics: api, api-client, csharp, sesame
- Language: C#
- Size: 28.3 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# Sesame.NET
A .NET client for the [Sesame API](https://docs.candyhouse.co/). Sesame.NET is licensed under the [MIT license](./LICENSE).
## Installation
You can either download the [Sesame.NET NuGet package](https://www.nuget.org/packages/Sesame) or download the binaries [directly from GitHub](https://github.com/veleek/sesame-net/releases/latest).
## Usage
1. Configure a Sesame API Key on [the CandyHouse Dashboard](https://my.candyhouse.co/#/credentials).
2. Initialize an instance of `SesameClient`.
```csharp
string apiKey = "";
SesameClient client = new SesameClient(apiKey);
```
3. Make other calls to list or control sesames.
```csharp
// Get ALL Sesames associated with the account.
List sesames = await client.ListSesamesAsync();
// Get a specific sesame and refresh it's state.
Sesame sesame = sesames.FirstOrDefault(s => s.NickName == "Home");
await sesame.RefreshAsync();
// Execute operations.
await sesame.LockAsync();
await sesame.UnlockAsync();
```
## Building
Sesame.NET is built using .NET Core (.NET Standard 1.4 and 2.0).
1. [Install .NET Core](https://www.microsoft.com/net/core)
2. Clone the Sesame.NET repository
3. Restore all of the NuGet packages for the project and build it
dotnet restore
dotnet build
4. *(Optional)* You can generate a NuGet package using the pack command
dotnet pack Sesame
# To build release package
# dotnet pack Sesame -c Release