Detector v2
API Documentation

2021-05-04, 08:23
Martin Kæstel Nielsen
- think.dk

v2 is deprecated - support ended in 2016. v4 is newest version - Upgrade now.

The Detector API provides a range of tools for different needs. The preferred method is using a server-side request and storing the segment in the users session, as this provides the best user experience and fewest possible requests to the Detector server. See our implementation guide for simplified examples.

If you are restrained from implementing a server-side request, a simple JavaScript include method is also available.

Be aware of our terms.

The API is available at http://detector-v2.dearapi.com.

Identification

http://detector-v2.dearapi.com/

Performs segment identification based on device useragent, with the purpose of returning segment as a HTML snippet.

Useragent defaults to requesting device but specific useragent can be sent using the ua parameter.

POST or GET parameters

ua: Optional useragent to be identified. Defaults to requesting device useragent.
site: Optional origin site. We recommend you to add this parameter to your request to provide better usage statistics.
file: Optional origin file. We recommend you to add this parameter to your request to provide better usage statistics.

Request

http://detector-v2.dearapi.com/

Returns HTML formatted segment.

<!DOCTYPE html>
<html>
<body>
<div id="device">
	<span id="segment" class="proporty">desktop_light</span>
</div>
</body>
</html>

Test this endpoint

http://detector-v2.dearapi.com/xml

Performs segment identification based on device useragent, with the purpose of returning segment as a XML snippet.

Useragent defaults to requesting device but specific useragent can be sent using the ua parameter.

POST or GET parameters

ua: Optional useragent to be identified. Defaults to requesting device useragent.
site: Optional origin site. We recommend you to add this parameter to your request to provide better usage statistics.
file: Optional origin file. We recommend you to add this parameter to your request to provide better usage statistics.

Request

http://detector-v2.dearapi.com/xml

Returns XML formatted segment.

<?xml version="1.0" encoding="UTF-8"?>
<device>
    <segment>desktop_light</segment>
</device>

Test this endpoint

http://detector-v2.dearapi.com/jsonp

Performs segment identification based on device useragent, with the purpose of returning segment to local callback function.

Useragent defaults to requesting device but specific useragent can be sent using the ua parameter.

POST or GET parameters

ua: Optional useragent to be identified. Defaults to requesting device useragent.
site: Optional origin site. We recommend you to add this parameter to your request to provide better usage statistics.
file: Optional origin file. We recommend you to add this parameter to your request to provide better usage statistics.
callback: Optional callback function. Defaults to "callback"

Request

http://detector-v2.dearapi.com/jsonp

Returns JSONP callback function with segment.

callback({"segment":"desktop_light"});

Test this endpoint

http://detector-v2.dearapi.com/js-include

Performs segment identification based on device useragent, with the purpose of returning appropriate JavaScript and CSS segment includes without using local server-side technology.

Requesting page should save segment in client-side cookie to avoid making repeating requests from same browsing session.

Useragent defaults to requesting device but specific useragent can be sent using the ua parameter.

GET parameters

ua: Optional useragent to be identified. Defaults to requesting device useragent.
site: Optional origin site. We recommend you to add this parameter to your request to provide better usage statistics.
file: Optional origin file. We recommend you to add this parameter to your request to provide better usage statistics.
path: Optional general include path. Defaults to /js and /css.
css_path: Optional CSS include path.
css_param: Optional CSS include file parameter.
js_path: Optional JavaScript include path.
js_param: Optional JavaScript include file parameter.
dev: Optional development include. Will include /css/lib/seg_segment_include.css and /js/lib/seg_segment_include.js following the recommended structure from http://janitor.parentnode.dk.

Request

http://detector-v2.dearapi.com/js-include

Returns JavaScript document.write's with JavaScript and CSS segment includes.

document.write('<link type="text/css" rel="stylesheet" media="all" href="/css/seg_desktop_light.css" />');
document.write('<script type="text/javascript" src="/js/seg_desktop_light.js"></script>');

Test this endpoint

Debugging

http://detector-v2.dearapi.com/debug

Performs segment identification based on device useragent, but collects and sends additional information to the development team.

Useragent defaults to requesting device but specific useragent can be sent using the ua parameter.

POST or GET parameters

ua: Optional useragent to be identified. Defaults to requesting device useragent.

Request

http://detector-v2.dearapi.com/debug

Returns extended set of device details, and sends email with debug information to development team.

Detector v2 API Documentation

Identification

http://detector-v2.dearapi.com/

Request

http://detector-v2.dearapi.com/xml

Request

http://detector-v2.dearapi.com/jsonp

Request

http://detector-v2.dearapi.com/js-include

Request

Debugging

http://detector-v2.dearapi.com/debug

Request

Detector v2
API Documentation