< documentation.
## Basic Usage ##
The DeviceAtlas Cloud Client API can be used as follows:
### Instantiate the client ###
First, we create an instance of the client with the licence key.
```javascript
const Config = require('deviceatlas-cloud-nodejs').Config;
const Client = require('deviceatlas-cloud-nodejs').Client;
const config = new Config("LICENCE KEY");
const client = new Client(config);
```
### Device Identification ###
Now that we have the client instantiated, there are two device
identification methods:
#### Identification via headers ####
The device can be identified by passing a set of HTTP headers:
```javascript
const headers = {
'User-Agent': 'Mozilla/5.0 (Linux; U; Android 2.3.3; en-gb; GT-I9100 Build/GINGERBREAD) AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0 Mobile Safari/533.1',
'Accept-Language': 'en-US'
};
client.getProperties(headers).then((properties) => {
console.log(properties)
}) .catch((error) => {
console.error('Error performing identification:', error);
});
```
#### Identification via a request object ####
The device can be identified by passing a request object:
```javascript
app.get('/', async (req, res) => {
client.getPropertiesFromRequest(req).then((properties) => {
console.log(properties);
}) .catch((error) => {
console.error('Error performing identification:', error);
});
});
```
See the list of all property names here:
https://deviceatlas.com/resources/available-properties
The availability of a property depends on the device and your licence, before
accessing a property always check if it exists in the set or not.
### Additional Examples ###
Please find more complete examples in the /Examples directory.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_ Copyright (c) DeviceAtlas Limited 2024. 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">Cloud Client API Introduction</a></li><li><a href="README.Installation.html">Cloud Client API Installation</a></li><li class="disabled"><a href="README.CloudApi.html">Cloud Client API Usage</a></li><li><a href="README.Config.html">Cloud Client API Configuration</a></li><li class="divider"></li><li><a href="./ApiDocs/index.html">DeviceAtlas Cloud Client API NodeJS docs</a></li></ul></div>]]>