Getting Started - DeviceAtlas for Web

Resources

Follow these simple steps to have the DeviceAtlas Enterprise API working locally within a few minutes.
If you do not have a licence, please contact us to request an evaluation.

1. Download Device Data File

This step is not required for Java API.

For the Enterprise solution, device data is packaged in a JSON format, which is highly compressed to reduce server footprint, and is optimized for speed of search and retrieval. It can either be downloaded manually or fetched with an automated script.

Refer to our Device Data (JSON) reference documentation to know more about DeviceAtlas data downloads.

2. Device Identification API

Java

Node.JS

PHP

.NET

Python

Ruby

C++

Nginx

HaProxy

Apache

IIS

Download Java DeviceAtlas Enterprise API

Create an API instance and load the data file

DeviceApi deviceApi = new DeviceApi();
deviceApi.downloadAndLoadDataFile("https://deviceatlas.com/getJSON?licencekey=YOUR-LICENCE-KEY&index=web&format=gzip");

Detect device properties by HTTP headers

Map<String, String> headers = new HashMap<String, String>();
headers.put("HEADER NAME", "HEADER VALUE");
Properties properties = deviceApi.getProperties(headers);

Detect device properties by user-agent string

String userAgent = "THE USER AGENT VALUE";
Properties properties = deviceApi.getProperties(userAgent);

Detect if mobile device

boolean mobileDevice = properties.contains("mobileDevice", true);
int displayWidth = properties.containsKey("displayWidth")? properties.get("displayWidth").asInteger(): 100;
String vendor = properties.containsKey("vendor")? properties.get("vendor").asString(): "";
boolean useBiggerIcons = properties.contains("touchScreen", true);

Download Java DeviceAtlas Enterprise API

Create an API instance and load the data file

var deviceApi = new DeviceApi();
deviceApi.loadDataFromFile('/path/to/DeviceAtlas.json');

Detect device properties

var properties = deviceApi.getPropertiesFromRequest(request);

Detect if mobile device

var mobileDevice = properties.contains('mobileDevice', true);
var displayWidth = properties.containsKey('displayWidth')? properties.get('displayWidth').getValue(): 100;
var vendor = properties.containsKey('vendor')? properties.get('vendor').getValue(): '';
var useBiggerIcons = properties.contains('touchScreen', true);

Download Java DeviceAtlas Enterprise API

Create an API instance and load the data file

$deviceApi = new Mobi_Mtld_DA_Device_DeviceApi();
$deviceApi->loadDataFromFile("/path/to/DeviceAtlas.json");

Detect device properties

$properties = $deviceApi->getProperties();

Detect if mobile device

$mobileDevice = $properties->contains("mobileDevice", true);
$displayWidth = $properties->containsKey("displayWidth") ? $properties->get("displayWidth")->asInteger() : 100;
$vendor = $properties->containsKey("vendor") ? $properties->get("vendor")->asString() : "";
$useBiggerIcons = $properties->contains("touchScreen", true);

Download Java DeviceAtlas Enterprise API

Create an API instance and load the data file

DeviceApi deviceApi = new DeviceApi();
deviceApi.LoadDataFromFile("/path/to/DeviceAtlas.json");

Detect device properties by HTTP headers

IDictionary<string, string> headers = new Dictionary<string, string>() { {"HEADER NAME", "HEADER VALUE"} };
Properties properties = deviceApi.GetProperties(headers);

Detect device properties by user-agent string

string userAgent = "THE USER AGENT VALUE";
Properties properties = deviceApi.GetProperties(userAgent);

Detect if mobile device

bool mobileDevice = properties.Contains("mobileDevice", true);
int displayWidth = properties.ContainsKey("displayWidth")? properties["displayWidth"].AsInteger(): 100;
string vendor = properties.ContainsKey("vendor")? properties["vendor"].AsString(): "";
bool useBiggerIcons = properties.Contains("touchScreen", true);

Download Java DeviceAtlas Enterprise API

Create an API instance and load the data file

device_api = DeviceApi()
device_api.load_data_from_file("/path/to/DeviceAtlas.json")

Detect device properties

headers = {"User-Agent": "THE USER AGENT VALUE"}
properties = device_api.get_properties(headers)

Detect if mobile device

mobile_device = properties.contains("mobileDevice", True)
display_width = int(properties["displayWidth"]) if ("displayWidth" in properties) else 100
vendor = properties.get("vendor") if "vendor" in properties else ""
use_bigger_icons = properties.contains("touchScreen", True)

Download Java DeviceAtlas Enterprise API

Create an API instance and load the data file

device_api = Mobi::Mtld::Da::Device::DeviceApi.new
device_api.load_data_from_file "/path/to/DeviceAtlas.json"

Detect device properties

headers = {"User-Agent" => "THE USER AGENT VALUE"}
properties = device_api.get_properties headers

Detect if mobile device

mobile_device = properties.contains?(:"mobileDevice", true)
display_width = properties.has_key?(:displayWidth) ? properties[:displayWidth].to_i : 100
vendor = properties.has_key?(:vendor) ? properties.get(:vendor) : ""
use_bigger_icons = properties.contains?(:"touchScreen", true)

Download Java DeviceAtlas Enterprise API

Load the data file

da_atlas_t deviceApi;
da_status_t status;
void *ptr;
size_t size;
FILE *jsonp;
time_t jsond;
const char *jsonpath = "/path/to/DeviceAtlas.json";
const char *useragent = "THE USER AGENT VALUE";
const char *curpropname;

da_evidence_id_t useragentid;
da_deviceinfo_t device;
da_type_t curtype;
da_propid_t *curprop;
da_property_decl_t extraprops[1] = { { 0, 0 } };

if ((jsonp = fopen(jsonpath, "r")) == NULL) {
    fprintf(stderr, "fopen failed: %s\n", jsonpath);
    return 0;
}

ex_da_init();

if ((status = da_atlas_compile(jsonp, jsonread, jsonseek, &ptr, &size)) != DA_OK) {
    fclose(jsonp);
    fprintf(stderr, "da_atlas_compile failed (status = %d)\n", status);
    ex_da_fini();
}

fclose(jsonp);

if ((status = da_atlas_open(&deviceApi, extraprops, ptr, size)) != DA_OK) {
    fprintf(stderr, "da_atlas_open failed (status = %d)\n", status);
    ex_da_fini();
}

Detect device properties

useragentid = da_atlas_header_evidence_id(&atlas, "User-Agent");

if ((status = da_search(&deviceApi, &device, useragentid, useragent, 0)) == DA_OK) {
    for (status = da_getfirstprop(&device, &curprop); status == DA_OK;
            status = da_getnextprop(&device, &curprop)) {
        da_getpropname(&device, *curprop, &curpropname);
        da_getproptype(&device, *curprop, &curtype);

        if (strcmp(curpropname, "mobileDevice") == 0) {
            bool curvalue;
            da_getpropboolean(&device, *curprop, &curvalue);
            printf("%s => %s\n", curpropname, curvalue ? "true" : "false");
        }

        if (strcmp(curpropname, "displayWidth") == 0) {
            long curvalue;
            da_getpropinteger(&device, *curprop, &curvalue);
            printf("%s => %d\n", curpropname, curvalue ? curvalue : 100);
        }

        if (strcmp(curpropname, "vendor") == 0) {
            const char *curvalue;
            da_getpropstring(&device, *curprop, &curvalue);
            printf("%s => %s\n", curpropname, curvalue ? curvalue : "");
        }
    }
    da_close(&device);
}

da_atlas_close(&deviceApi);
free(ptr);

Download Java DeviceAtlas Enterprise API

Create an API instance and load the data file

Da::DeviceAtlas deviceApi;
deviceApi.loadDataFromFile("/path/to/DeviceAtlas.json");

Detect the device properties

Da::HeaderMap map;
map["user-agent"] = "THE USER AGENT VALUE";

...

Da::HttpHeaders headers(map);
Da::DeliveryContext properties(deviceApi, headers);

Detect if mobile device

mobileDevice = properties.contains("mobileDevice", true);
displayWidth = (long)*properties["displayWidth"];
vendor = (std::string)*properties["vendor"];
useBiggerIcons = (bool)*properties["touchScreen"];

Download Java DeviceAtlas Enterprise API

Create an API instance and load the data file

var da *deviceatlas.DaGo
da = deviceatlas.New()
_, err := da.LoadDataFromFile("/path/to/DeviceAtlas.json")

Detect device properties

m := make(map[string]string)
m["user-agent"] = "THE USER AGENT VALUE"
properties := da.Detect(m);

Detect if mobile device

mobileDevice := properties["mobileDevice"]
displayWidth := properties["displayWidth"]
vendor := properties["vendor"]
useBiggerIcons := properties["touchScreen"]

Download Java DeviceAtlas Enterprise API

Load the DeviceAtlas module

load_module /path/to/ngx_http_deviceatlas_module.so;

Configure the path to the data file

variables_hash_max_size 2048;
devatlas_db "/path/to/DeviceAtlas.json";

Make properties available for the FastCGI layer

fastcgi_param DA_MOBILE_DEVICE $da_mobileDevice;
fastcgi_param DA_DISPLAY_WIDTH $da_displayWidth;
fastcgi_param DA_VENDOR $da_vendor;
fastcgi_param DA_TOUCH_SCREEN $da_touchScreen;

Example: Mobile redirection

# In HTTP block
map $da_mobileDevice $redirectToAMP {
    true 1;
    false 0;
    default 0;
}

# In server block
if ($redirectToAMP) {
    rewrite ^/(index.html|^/|)$ /AMP/$1 last;
}

Download Java DeviceAtlas Enterprise API

Configure the path to the data file

global
    deviceatlas-json-file <path to DeviceAtlas json file>

Transmit the DeviceAtlas data downstream to the target application

http-request set-header X-DeviceAtlas-Data %[da-csv-fetch(mobileDevice,displayWidth,vendor,touchScreen)]

Mobile content switching with ACL

acl is_mobile da-csv-fetch(mobileDevice) 1

Download Java DeviceAtlas Enterprise API

Load the DeviceAtlas module

LoadModule da_module "/path/to/module/libmod_da.so"

Configure the path to the data file

<VirtualHost *:80>
    DA On
    DAJsonFilePath "/path/to/DeviceAtlas.json"
    DocumentRoot /var/www/html
</VirtualHost>

Example: Rewrite rule to utilize the isMobile header

<Directory "/var/www/html/">
    RewriteEngine On
    RewriteCond "%{HTTP:X-DeviceAtlas-mobileDevice}" 1
    RewriteRule "^/(index.html|^/|)$"  "/mobile.html" [L]
</Directory>

Download Java DeviceAtlas Enterprise API

Configure the path to the data file

DAJSONFILEPATH=/path/to/DeviceAtlas.json

ASP.NET Example

if (Request.Headers["HTTP_X_DEVATLAS_MOBILEDEVICE"] != null
    && Request.Headers["HTTP_X_DEVATLAS_MOBILEDEVICE"].ToString().Equals("1")) {
}

You can find all information related to the Java DeviceAtlas Enterprise API here.

3. Data File Options

Default data file only has 21 out of 177 properties selected. Please visit Data File Options page to customize which device properties are to be included in data file.

4. Client-side Component

The Client-side Component is needed for granular identification of iOS devices, as well as for other dynamic properties. Please visit DeviceAtlas Client-side Component.

Questions?

If you need assistance, contact us at support@deviceatlas.com for technical support directly from R&D. For business questions and access to an evaluation licence, contact sales.

Resources