A Simple Web API Helper

This post gives you the code to help you build an API url with the parameters and a quick way to call a simple get method and parse the results to the object you are expecting back from the API.

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
namespace CodeShare.Library.Helpers { public class ApiHelper { public string BuildApiUrl(string domainAddress, string controllerName, string methodName, List<KeyValuePair<string, object>> parameters, string apiLocation) { StringBuilder url = new StringBuilder(); url.Append($"{domainAddress}/{apiLocation}{controllerName}/{methodName}"); if (parameters != null && parameters.Count > 0) { int parameterCount = parameters.Count; for (int i = 0; i < parameterCount; i++) { url.Append(i == 0 ? "?" : "&"); url.Append($"{parameters[i].Key}={parameters[i].Value.ToString()}"); } } return url.ToString(); }
public T GetResultFromApi(string url) { using (HttpClient httpClient = new HttpClient()) { Task response = httpClient.GetStringAsync(url); return Task.Factory.StartNew(() => JsonConvert.DeserializeObject(response.Result)).Result; } } } }

Usage Example

And here is how you would call it.

using CodeShare.Library.Helpers;

var user = new HttpContextWrapper(HttpContext.Current).User; List<KeyValuePair<string, object>> parameters = new List<KeyValuePair<string, object>>(); parameters.Add(new KeyValuePair<string, object>("username", user.Identity.Name)); parameters.Add(new KeyValuePair<string, object>("mediaPath", context.Request.FilePath)); ApiHelper apiHelper = new ApiHelper();
string url = apiHelper.BuildApiUrl( domainAddress: "http://www.example.com", apiLocation: "Umbraco/Api/", controllerName: "ProtectedMediaApi", methodName: "IsAllowed", parameters: parameters);
bool isAllowed = apiHelper.GetResultFromApi(url);

About the author

Paul Seal

A .NET Web Developer from Derby (UK) who specialises in building Content Management System (CMS) websites using MVC with Umbraco as a framework. Paul is passionate about web development and programming as a whole. Apart from when he's with his wife and son, if he's not writing code, he's thinking about it or listening to a podcast about it.

Related Posts

What is Umbraco CMS

This post tells you what Umbraco CMS is and what the benefits of using it are.

Read Post

How to set up Raygun on your .NET website

This post shows you how to set up Raygun on your .NET website. It gives you step by step instruction…

Read Post

CodeShare Starter Kit for Umbraco

CodeShare Starter Kit was built for Umbraco version 7.7.6 and above. It uses Nested Content which is…

Read Post

How to create a Carousel in Umbraco using Nested Content and Bootstrap

This post will show you how to build a carousel in umbraco using Nested Content and Bootstrap

Read Post