< documentation.
#### Basic Usage ####
The DeviceAtlas Cloud Client API can be used as follows:
* Include the DeviceAtlas Cloud Client API in your application.
```python
from deviceatlas.cloud.device import Client
```
* Get an instance of the API, set your DeviceAtlas licence key and get the properties.
```python
# Detecting based on a set of HTTP headers:
headers = {
'User-Agent': 'THE USER AGENT...',
...
...
}
try:
client = Client()
client.LICENCE_KEY = 'ENTER-YOUR-LICENCE-KEY'
result = client.getDeviceData(headers)
if Client.KEY_PROPERTIES in result:
properties = result[Client.KEY_PROPERTIES]
except TypeError as type_error:
print("Invalid Licence Key")
except Exception as error:
print(error.message)
```
```python
# Detecting based on a user agent string
user_agent = 'THE USER AGENT...'
try:
client = Client()
client.LICENCE_KEY = 'ENTER-YOUR-LICENCE-KEY'
result = client.getDeviceData(user_agent=user_agent)
if Client.KEY_PROPERTIES in result:
properties = result[Client.KEY_PROPERTIES]
except TypeError as type_error:
print("Invalid Licence Key")
except Exception as error:
print(error.message)
```
```python
# To get the HTTP headers from a framework such a Django
try:
client = Client()
client.LICENCE_KEY = 'ENTER-YOUR-LICENCE-KEY'
result = client.getDeviceData(request.META)
if Client.KEY_PROPERTIES in result:
properties = result[Client.KEY_PROPERTIES]
except TypeError as type_error:
print("Invalid Licence Key")
except Exception as error:
print(error.message)
```
* Use the device properties:
```python
if "mobileDevice" in properties and properties["mobileDevice"]:
# example 1: Get the screen width for image optimization
display_width = properties.get('displayWidth', 100)
# example 2: Get the device vendor name
vendor = properties.get('vendor', "")
# example 3: Touch screen optimization
use_bigger_icons = properties.get('touchScreen', False)
# example 4: Send Geo Location JS to client?
support_geo_location = properties.get('js.geoLocation', False)
```
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.
* When DEBUG_MODE = False or API version < 1.4
```python
client = Client()
client.LICENCE_KEY = 'ENTER-YOUR-LICENCE-KEY'
# try to find the HTTP headers in os.environ
device_data = client.getDeviceData()
# get the properties
if Client.KEY_ERROR in data:
print(device_data[Client.KEY_ERROR])
else:
# get the properties
if Client.KEY_PROPERTIES in device_data:
properties = device_data[Client.KEY_PROPERTIES]
```
### Examples ###
Various examples are included in this package to clearly demonstrate the API
features, usage and some use cases. These examples are very simple and are
heavily commented.
#### Basic Usage ####
Includes two examples. One simple command line example which uses API to detect
and get properties from header sets. The other example is a web application.
This example uses the API for the current request to automatically detect and get
the properties. Using custom API configs and the client-side-component is shown
in this example.
* Command line example:
```shell
$ python deviceatlas-cloud-python-2.2/Examples/basic-usage/detect.py
```
* Web example:
```shell
$ python deviceatlas-cloud-python-2.2/Examples/web-app/example.py
```
And access http://localhost:3000 from browser.
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 2023. 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</a></li><li><a href="README.Installation.html">Cloud Client API Installation</a></li><li><a href="README.Upgrade.html">Cloud Client API Upgrade</a></li><li><a href="README.Config.html">Cloud Client API Configuration</a></li><li><a href="./ApiDocs/index.html">DeviceAtlas Cloud Client API doc</a></li></ul></div>]]>