Getting Started - DeviceAtlas for Apps

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++

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=apps&format=gzip");

Detect device properties

String makeModel = "samsung SM-N9005".toLowerCase();
Properties properties = deviceApi.getProperties(makeModel);

Download Java DeviceAtlas Enterprise API

Create an API instance and load the data file

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

Detect device properties

var makeModel = "samsung SM-N9005".toLowerCase();
var properties = deviceApi.getProperties(makeModel);

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/apps_datafile.json");

Detect device properties

$makeModel = strtolower("samsung SM-N9005");
$properties = $deviceApi->getProperties($makeModel);

Download Java DeviceAtlas Enterprise API

Create an API instance and load the data file

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

Detect device properties

string makeModel = "samsung SM-N9005".ToLower();
Properties properties = deviceApi.GetProperties();

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/apps_datafile.json")

Detect device properties

makeModel = "samsung SM-N9005".lower()
properties = device_api.get_properties(makeModel)

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/apps_datafile.json"

Detect device properties

makeModel = "samsung SM-N9005".downcase
properties = device_api.get_properties(makeModel)

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/web_datafile.json";
const char *makeModel = "samsung SM-N9005";
for (char p = makeModel; *p; ++p) *p = tolower(*p);
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");
da_search(&deviceApi, &device, useragentid, makeModel, 0);

Download Java DeviceAtlas Enterprise API

Create an API instance and load the data file

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

Detect device properties

const char *makeModel = "samsung SM-N9005";
for (char p = makeModel; *p; ++p) *p = tolower(*p);
Da::DeliveryContext properties(deviceApi, makeModel);

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/apps_datafile.json")

Detect device properties

makeModel := strings.ToLower("samsung SM-N9005")
properties := da.Detect(makeModel);

3. Expected string format for DeviceAtlas lookup

DeviceAtlas expects the make/model string in a specific format.

This format consists of values separated by a space character, where the mandatory values are manufacturer and model. The string is the same for all platforms:

"Make Model"

The term "Make" stands for manufacturer and the term "Model" stands for a model number.

It is important to pass the string to the DeviceAtlas API in the lowercase form when using lowercased data file. Modifications to the strings risk resulting in non-identification or mis-identification.

Platform Specific Code (Make/Model)

The following code snippets detail how to obtain the make/model for the most common mobile platforms. This or similar code needs be included in the mobile application gathering the data to be passed to the DeviceAtlas API.

android

ios

Obtain the make/model string

String make = android.os.Build.MANUFACTURER;
String model = android.os.Build.MODEL;
String makeModel = make + " " + model;

Make/model string examples from random devices

samsung SM-N9005
HTC HTC One mini 2
Meizu m2 note
OnePlus A0001
LGE Nexus 4

Obtain the make/model string

NSString *make = @"Apple";
NSSString *model = [NSString stringWithCString:systemInfo.machineencoding:NSUTF8StringEncoding];
NSString *makeModel = [make stringByAppendingString:model];

Make/model string examples from random devices

Apple iPhone7,1
Apple iPad3,4

Note that the HTC example includes the "HTC" information twice. That is because some devices are configured by the vendors to include manufacturer information within the model (e.g. make = "HTC", model = "HTC One mini 2"). This is handled by the DeviceAtlas API, there is no need to manipulate the strings in advance.

4. 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.

5. 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