# DeviceAtlas Device Detection for Web # The DeviceAtlas Device Detection API for Web provides a way to detect devices based on the HTTP headers. Using the headers, the API returns device information such as screen width, screen height, is mobile, vendor, model etc. To see a full list of properties in DeviceAtlas please visit: https://deviceatlas.com/resources/available-properties . ### Data File ### The DeviceAtlas API relies on a device data file to function. DeviceAtlas provides daily data file updates so it is recommended to download the data file on a regular basis. This can be done manually from your account page or automated via the https://deviceatlas.com/getJSON page. For more information please see: https://deviceatlas.com/resources/getting-the-data ### Dependencies ### This library does not depend on any third party libraries. ### Library ### The DeviceAtlas API is a single package that contains a single module for the Device Detection API. #### DeviceApi #### The main library that loads the Device data and detects and returns the properties for a set of request headers or a user-agent. Client-side properties can be optionally passed to this library to get more accurate results. ### Basic Usage ### The API can be used as follows: To lookup the properties by manually passing the Hash of headers to the API: ```c #include <dac.h> // The 2 functions below are necessary for da_atlas_compile // as it needs 2 function pointers for reading and seeking in the data file static size_t filereader(void *ctx, size_t count, char *buf) { return fread(buf, 1, count, ctx); } static da_status_t fileseeker(void *ctx, off_t pos) { return fseek(ctx, pos, SEEK_SET) != -1 ? DA_OK : DA_SYS; } ... da_atlas_t atlas; da_status_t status; void *ptr; size_t size; /** * When the JSON file is supplied */ const char *jsonpath = argv[1]; ... // Json file reading FILE *json = fopen(jsonpath, "r"); if (!json) { fprintf(stderr, "fread failed: %s\n", jsonpath); exit(EXIT_FAILURE); } da_init(); if ((status = da_atlas_compile(json, filereader, fileseeker, &ptr, &size)) != DA_OK) { fprintf(stderr, "da_atlas_compile failed\n"); goto dafini; } /** * Or when the binary file dumped previously by da_atlas_dump_mapped * or from in RAM data */ ... const char *binarypath = "data.bin"; void *m; if ((status = da_atlas_read_mapped(binarypath, m, &ptr, &size)) != DA_OK) { fprintf(stderr, "da_atlas_read_mapped failed\n"); goto daclose; } ... da_property_decl_t extraprops[] = {{ 0, 0 }}; if ((status = da_atlas_open(&atlas, extraprops, ptr, size)) != DA_OK) { fprintf(stderr, "da_atlas_open failed\n"); goto daclose; } /** * Optional: dumping the API memory state into a binary file */ ... const char *binaryPath = "./data.bin"; void *bin; size_t binlen; if ((status = da_atlas_dump_mapped(binarypath, &bin, &binlen, ptr, size)) != DA_OK) { fprintf(stderr, "da_atlas_dump_mapped failed\n"); goto daclose; } ... da_evidence_id_t mainid = da_atlas_evidence_id(&atlas, "user-agent"); da_evidence_id_t extraid = da_atlas_evidence_id(&atlas, extraheader); da_evidence_t headers[] = {{ mainid, useragent, extraid, extraval ... }}; da_deviceinfo_t device; if ((status = da_searchv(&atlas, &device, headers, 2)) != DA_OK) { fprintf(stderr, "da_search failed\n"); goto daclose; } da_propid_t *mprop; da_propid_t *dprop; da_propid_t *vprop; da_propid_t *jprop; da_propid_t *tprop; bool mobiledevice; bool touchscreen; bool jsgetlocation; long displaywidth; const char *vendor; da_atlas_getpropid(&atlas, "mobileDevice", mprop); da_atlas_getpropid(&atlas, "touchScreen", tprop); da_atlas_getpropid(&atlas, "js.geoLocation", jprop); da_atlas_getpropid(&atlas, "displayWidth", dprop); da_atlas_getpropid(&atlas, "vendor", vprop); if (da_getpropboolean(&device, *mprop, &mobiledevice) != DA_OK) mobiledevice = false; if (da_getpropboolean(&device, *tprop, &touchscreen) != DA_OK) touchscreen = false; if (da_getpropboolean(&device, *jprop, &jsgeolocation) != DA_OK) jsgeolocation = false; if (da_getpropinteger(&device, *dprop, &displaywidth) != DA_OK) displaywidth = 100; if (da_getpropstring(&device, *vprop, &vendor) != DA_OK) vendor = ""; da_close(&device); daclose: da_atlas_close(&atlas); free(ptr); dafini: da_fini(); ``` ### Client-side Component ### In addition to the properties from the data file, properties can be gathered from the client's browser and used both on the client side and on the server side. Please see the [Client-side readme file](README.ClientSide.html) for more information. #### Usage With Client-side Component #### In addition to normal usage, DeviceAtlas has the capability to capture client side properties and merge them into the server side properties. The "deviceatlas.min.js" file must be included on your webpage in order for it to detect the Client-side properties. The Client-side properties are returned to the server in a cookie called DAPROPS. The contents of this cookie are automatically detected with the request headers or can be passed separately, with Headers or a User-Agent, to get the combined properties back. Both sets of properties are used in additional logic to determine other properties such as iPhone and iPad models which are normally not detectable. ```c #include <dac.h> ... da_atlas_t atlas; da_status_t status; void *ptr; size_t size; const char *jsonpath = argv[1]; ... // Json file reading FILE *json = fopen(jsonpath, "r"); if (!json) { fprintf(stderr, "fread failed: %s\n", jsonpath); exit(EXIT_FAILURE); } da_init(); if ((status = da_atlas_compile(json, filereader, fileseeker, &ptr, &size)) != DA_OK) { fprintf(stderr, "da_atlas_compile failed\n"); goto dafini; } da_property_decl_t extraprops[] = {{ 0, 0 }}; if ((status = da_atlas_open(&atlas, extraprops, ptr, size)) != DA_OK) { fprintf(stderr, "da_atlas_open failed\n"); goto daclose; } da_evidence_id_t mainid = da_atlas_evidence_id(&atlas, "user-agent"); da_evidence_id_t clientid = da_atlas_header_evidence_id(&atlas); da_evidence_t headers[] = {{ mainid, useragent, clientid, daprops }}; da_deviceinfo_t device; if ((status = da_searchv(&atlas, &device, headers, 2)) != DA_OK) { fprintf(stderr, "da_search failed\n"); goto daclose; } if (da_getpropboolean(&device, *mprop, &mobiledevice) != DA_OK) mobiledevice = false; if (da_getpropboolean(&device, *tprop, &touchscreen) != DA_OK) touchscreen = false; if (da_getpropboolean(&device, *jprop, &jsgeolocation) != DA_OK) jsgeolocation = false; if (da_getpropinteger(&device, *dprop, &displaywidth) != DA_OK) displaywidth = 100; if (da_getpropstring(&device, *vprop, &vendor) != DA_OK) vendor = ""; da_close(&device); daclose: da_atlas_close(&atlas); free(ptr); ``` ### Sample applications ### There are multiple examples in the /Examples folder to test the API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - _ Copyright (c) DeviceAtlas Limited 2021. All Rights Reserved. _ _ https://deviceatlas.com _ <!-- HTML+JS for document formatting when opened in browser --> <div class="btn-group" id="main-menu" style="float:right"><a class="btn dropdown-toggle" data-toggle="dropdown" href="#">Menu<span class="caret"></span></a><ul class="dropdown-menu"><li><a href="README.html">Main</a></li><li class="divider"></li><li class="disabled"><a href="README.DeviceApi-Web.html">Device Detection for Web</a></li><li><a href="README.DeviceApi-Apps.html">Device Detection for Apps</a></li><li><a href="README.DeviceApi-Config.html">Device Detection API Config</a></li><li><a href="README.CarrierApi.html">Carrier Identification API</a></li><li class="divider"></li><li><a href="README.Unix.html">C API and Unix</a></li><li><a href="README.Windows.html">C API and Windows</a></li><li class="divider"></li><li><a href="README.Nginx.html">C API and NGINX Module Installation</a></li><li class="divider"></li><li><a href="README.JsonConverter.html">C API JSONConverter</a></li><li><a href="README.ClientSide.html">Client-side Component</a></li><li><a href="ApiDocs/index.html">DeviceAtlas ApiDocs</a></li></ul></div>