Simplecast .NET Client Library is a client library targeting .NET Standard 2.0 and .NET 4.6.1 that provides an easy way to interact with the Simplecast API (https://api.simplecast.com/)
All requests must be authenticated using your API key, available in your Simplecast account settings. You have the option of authenticating one of three different ways: using HTTP Basic Auth, passing it as a request parameter, or setting an HTTP header. Your API key is available in your Simplecast account settings.
- .NET 4.6.1 (Desktop / Server)
- .NET Standard 2.0
- Dependency injection friendly (can also be used standalone, see below)
- Supports async and sync (via extension method, see below) calls.
| Build server | Platform | Build status | Integration tests |
|---|---|---|---|
| Azure Pipelines | Windows | ||
| Azure Pipelines | Ubuntu | ||
| Azure Pipelines | MacOS | ||
| AppVeyor | Windows | ||
| Travis | Linux / MacOS |  |
Following commands can be used to install Simplecast.Client, run the following command in the Package Manager Console
Install-Package Simplecast.Client
Or use dotnet cli
dotnet Simplecast.Client
Simplecast.Client can be used with any DI library, or it can be used standalone.
If you do not want to use any DI framework, you have to instantiate SimplecastClientStandalone as follows.
ApiOptions apiOptions = new ApiOptions("<your token>", "https://api.simplecast.com/v1/");
var apiClientContext = SimplecastClientStandalone.Create(apiOptions);
IEpisodeClient episodeClient = apiClientContext.EpisodeClient;
IPlayerEmbedClient playerEmbedClient = apiClientContext.PlayerEmbedClient;
IPodcastClient podcastClient = apiClientContext.PodcastClient;
IStatisticClient statisticClient = apiClientContext.StatisticClient;apiClientContext contains all necessary clients.
First, you need to install Microsoft.Extensions.DependencyInjection and Microsoft.Extensions.Http NuGet package as follows
dotnet add package Microsoft.Extensions.DependencyInjection
dotnet add package Microsoft.Extensions.Http
By installing Microsoft.Extensions.Http you will be able to use HttpClientFactory.In the words of the ASP.NET Team it is “an opinionated factory for creating HttpClient instances” and is a new feature comes with the release of ASP.NET Core 2.1.
If you don't want to use HttpClientFactory, you must register HttpClient yourself with the container.
Register necessary dependencies to ServiceCollection as follows
var apiOptions = new ApiOptions("<your token>", "https://api.simplecast.com/v1/");
var services = new ServiceCollection();
services.AddSingleton(apiOptions);
services.AddHttpClient<IRestApiClient, RestApiClient>();
services.AddTransient<IPodcastClient, PodcastClient>();
services.AddTransient<IEpisodeClient, EpisodeClient>();
services.AddTransient<IPlayerEmbedClient, PlayerEmbedClient>();
services.AddTransient<IStatisticClient, StatisticClient>();
ServiceProvider buildServiceProvider = services.BuildServiceProvider();
var podcastClient = buildServiceProvider.GetRequiredService<IPodcastClient>();
var episodeClient = buildServiceProvider.GetRequiredService<IEpisodeClient>();
var playerEmbedClient = buildServiceProvider.GetRequiredService<IPlayerEmbedClient>();
var statisticClient = buildServiceProvider.GetRequiredService<IStatisticClient>();There are two ways to call an endpoint. The only difference is the return types. The methods that end with ResponseAsync returns ApiResponse<TModel> which contains model itself, HTTP status codes, error message and response headers.
ApiResponse<List<Episode>> episodesResponse = await episodeClient.GetEpisodesResponseAsync(podcastId);
if(episodesResponse.Error)
{
HttpStatusCode statusCode = episodesResponse.HttpStatusCode;
string errorMessage = episodesResponse.Message;
IDictionary<string, string> headers = episodesResponse.Headers;
string urlPath = episodesResponse.UrlPath;
// Handle http error
}
List<Episode> episodes = episodesResponse.Model;The methods that end with Async returns model itself without additional HTTP response information. But in the case of HTTP error, you need to handle exceptions.
List<Episode> episodes = await episodeClient.GetEpisodesAsync(podcastId);For synchronous calls, Task extension method RunSync can be used.
List<Episode> episodes= episodeClient.GetEpisodesAsync(podcastId).RunSync();But there is a possibility that this extension method can't cover all cases. See Stackoverflow article
Licensed under MIT, see LICENSE for the full text.