WURFL Microservice (by ScientiaMobile, Inc.) is a mobile device detection service that can quickly and accurately detect over 500 capabilities of visiting devices. It can differentiate between portable mobile devices, desktop devices, SmartTVs and any other types of devices that have a web browser.
This is the C#/dotNET Client API for accessing the WURFL Microservice. The API is released under Open-Source and can be integrated with other open-source or proprietary code. In order to operate, it requires access to a running instance of the WURFL Microservice product, such as:
-
WURFL Microservice for Docker: https://www.scientiamobile.com/products/wurfl-microservice-docker-detect-device/
-
WURFL Microservice for AWS: https://www.scientiamobile.com/products/wurfl-device-detection-microservice-aws/
-
WURFL Microservice for Azure: https://www.scientiamobile.com/products/wurfl-microservice-for-azure/
-
WURFL Microservice for Google Cloud Platform: https://www.scientiamobile.com/products/wurfl-microservice-for-gcp/
the Example project contains an example api usage for a console application : (Requires .NET framework 4.5.2 or above, or .NET Core framework 2.2.0 or above). Please note that old .NET framework versions are only supported by WM client legacy versions.
WURFL Microservice client runs on .NET Core framework since version 2.0.3.
Table of .NET core and WM Client compatibility
| .NET Core version | WM client version(s) | |
|---|---|---|
| net5.0 | 2.1.4, 2.1.3 | |
| netcoreapp3.1 | 2.1.4, 2.1.3, 2.1.2 | |
| netcoreapp2.2 | 2.1.1 |
using System;
using System.Collections.Generic;
using Wmclient;
namespace Example
{
public class WmClientExample
{
static void Main(string[] args)
{
try
{
// First we need to create a WM client instance, to connect to our WM server API at the specified host and port.
// Last parameter is a prefix for path, most of the time we won't need it
WmClient client = WmClient.Create("http" ,"localhost", "8080", "");
if (client != null)
{
// enable cache: by setting the cache size we are also activating the caching option in WM client.
// In order to not use cache, you just to need to omit setCacheSize call
client.SetCacheSize(100000);
// We ask Wm server API for some Wm server info such as server API version and info about WURFL API and file used by WM server.
JSONInfoData info = client.GetInfo();
Console.WriteLine("Server info: \n");
Console.WriteLine("WURFL API version: " + info.Wurfl_api_version);
Console.WriteLine("WM server version: " + info.Wm_version);
Console.WriteLine("WURFL file info:" + info.Wurfl_info + '\n');
var requestedStaticCaps = new string[]{
"brand_name",
"model_name"
};
var requestedVirtualCapabilities = new string[]{
"is_smartphone",
"form_factor"
};
// set the capabilities we want to receive from WM server
client.SetRequestedStaticCapabilities(requestedStaticCaps);
client.SetRequestedVirtualCapabilities(requestedVirtualCapabilities);
var ua = "UCWEB/2.0 (Java; U; MIDP-2.0; Nokia203/20.37) U2/1.0.0 UCBrowser/8.7.0.218 U2/1.0.0 Mobile";
Console.WriteLine("Device lookup for user-agent: " + ua);
// Perform a device detection calling WM server API
JSONDeviceData device = client.LookupUserAgent(ua);
// Let's get the device capabilities and print some of them
Console.WriteLine("Detected device WURFL ID: " + device.Capabilities["wurfl_id"]);
Console.WriteLine("Detected device brand & model: " + device.Capabilities["brand_name"]
+ " " + device.Capabilities["model_name"]);
Console.WriteLine("Detected device form factor: " + device.Capabilities["form_factor"]);
if (device.Capabilities["is_smartphone"].Equals("true"))
{
Console.WriteLine("This is a smartphone");
}
// Now let's print all the device capabilities
DumpDevice(device);
// Get all the device manufacturers, and print the first twenty
int limit = 20;
String[] deviceMakes = client.GetAllDeviceMakes();
Console.WriteLine(String.Format("Print the first {0} Brand of {1}\n", limit, deviceMakes.Length));
// Sort the device manufacturer names
Array.Sort(deviceMakes);
for (int i = 0; i < limit; i++)
{
Console.WriteLine(String.Format(" - {0}\n", deviceMakes[i]));
}
// Now call the WM server to get all device model and marketing names produced by Apple
Console.WriteLine("Print all Model for the Apple Brand");
JSONModelMktName[] devNames = client.GetAllDevicesForMake("Apple");
// Sort ModelMktName objects by their model name (a specific comparer is used)
Array.Sort(devNames, new ByModelNameComparer());
foreach (JSONModelMktName modelMktName in devNames)
{
Console.WriteLine(" - {0} {1}\n", modelMktName.Model_Name, modelMktName.Marketing_Name);
}
// Now call the WM server to get all operative system names
Console.WriteLine("Print the list of OSes");
String[] oses = client.GetAllOSes();
// Sort and print all OS names
Array.Sort(oses);
foreach (String os in oses)
{
Console.WriteLine(String.Format(" - {0}\n", os));
}
// Let's call the WM server to get all version of the Android OS
Console.WriteLine("Print all versions for the Android OS");
String[] osVersions = client.GetAllVersionsForOS("Android");
// Sort all Android version numbers and print them.
Array.Sort(osVersions);
foreach (String ver in osVersions)
{
Console.WriteLine(" - {0}\n", ver);
}
}
else
{
Console.WriteLine("WmClient instance is null");
}
// Deallocate all client resources. Any call on client method after this one will throw a WmException
client.DestroyConnection();
}
catch (WmException e)
{
// problems such as network errors or internal server problems
Console.WriteLine(e.Message);
}
finally
{
Console.Write("Press a key...");
Console.ReadKey();
}
}
// Prints all the device capabilities
private static void DumpDevice(JSONDeviceData device)
{
if(device.Capabilities.Count > 0)
{
Console.WriteLine("Requested device capabilities");
Console.WriteLine();
var capKeys = device.Capabilities.Keys;
foreach(string key in capKeys)
{
Console.WriteLine("Capability " + key + ": " + device.Capabilities[key]);
}
}
}
}
// Comparer implementation used to sort JSONModelMktName objects according to their model name property,
// for which is used the String natural ordering.
internal class ByModelNameComparer : IComparer<JSONModelMktName>
{
public int Compare(JSONModelMktName o1, JSONModelMktName o2)
{
if (o1 == null && o2 == null) { return 0; }
if (o1 == null && o2 != null)
{
return 1;
}
if (o1 != null && o2 == null)
{
return -1;
}
return o1.Model_Name.CompareTo(o2.Model_Name);
}
}
}
Alternatively, if code is running inside a web application that provides a HttpRequest instance, you can initialize WM client inside - for example, in the global.asax file
protected void Application_Start()
{
WpcClient client = WpcClient.Create("localhost", "8081");
var requestedCapabilities = new string[]{
"brand_name",
"model_name",
"is_mobile",
"is_tablet",
"is_smartphone"
};
client.SetRequestedCapabilities(requestedCapabilities);
}
and then use it wherever it's needed, for example in a ASP MVC controller method
public ActionResult MyControllerMethod()
{
var req = System.Web.HttpContext.Current.Request;
JSONDeviceData device = client.LookupRequest(req);
[...]
}
You can also use all HTTP headers to perform a device detection:
var headers = new Dictionary<String, String>();
headers.Add("Content-Type", "application/json");
headers.Add("Accept-Encoding", "gzip, deflate");
headers.Add("Accept-Language", "en");
headers.Add("Referer", "https://www.cram.com/flashcards/labor-and-delivery-questions-889210");
headers.Add("User-Agent", "Opera/9.80 (Android; Opera Mini/51.0.2254/184.121; U; en) Presto/2.12.423 Version/12.16");
headers.Add("X-Clacks-Overhead", "GNU ph");
headers.Add("X-Forwarded-For", "110.54.224.195, 82.145.210.235");
headers.Add("X-Operamini-Features", "advanced, camera, download, file_system, folding, httpping, pingback, routing, touch, viewport");
headers.Add("X-Operamini-Phone", "Android #");
headers.Add("X-Operamini-Phone-Ua", "Mozilla/5.0 (Linux; Android 8.1.0; SM-J610G Build/M1AJQ; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/69.0.3497.100 Mobile Safari/537.36");
headers.Add("Accept", "text/html, application/xml;q=0.9, application/xhtml+xml, image/png, image/webp, image/jpeg, image/gif, image/x-xbitmap, */*;q=0.1");
headers.Add("Device-Stock-Ua", "Mozilla/5.0 (Linux; Android 8.1.0; SM-J610G Build/M1AJQ; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/69.0.3497.100 Mobile Safari/537.36");
headers.Add("Forwarded", "for=\"110.54.224.195:36350\"");
// Perform a device detection calling WM server API passing the whole request headers
JSONDeviceData device = client.LookupHeaders(headers);