Is there a mandatory presence in nsit

Yourbrowser.is API - browser detail detection

Yourbrowser.is API version 1.1 reference

purpose

API allows you to enable end-user browsing environment, including web browser details, browser plug-ins, the presence of ad blockers (if any) to detect login status on social networks, mobile devices and much more. The tool also lets you measure the user's connection speed. See the "Checks" section for a detailed list of the acquisitions that can be made.

The API is available with yourbrowser.is PRO account for $ 19 price / month or $ 209 / year.

use

To check the end users' browsing environment, follow the steps below:

  1. Create a checker.
  2. Send the URL to the user asking them to open it.
  3. Receive report list collected by Checker.
  4. Receive selected reports.

Read on for more details.

The API usage is limited to 100 requests per minute. If you have larger needs, please contact us.

Base url and formats

The API is available at the following URL and can be accessed via HTTP or HTTPS.

http://api.yourbrowser.is/

All inquiries are sent via POST.
Requests and responses are in JSON format.

Authentication

To use the API you need an API key. This key must be included in all inquiries.
You can find your API key in the Settings section of yourbrowser.is User Panel (assuming you are a Pro Account user).

status

Every API response begins with a status. Below is a list of all possible statuses and their descriptions.

statusdescription
OKRequest accepted, answer will follow.
CREATED[create_checker only] The checker was created successfully
UPDATED[create_checker only] The checker configuration was updated successfully
ERRORSomething went wrong. This status always comes with the error code and error text, see table below.

error

Error code, text and descriptions:

ERRNOERRTXTdescription
1FUNCTION DOES NOT EXISTThe method used does not exist.
2NO DATANo data could be obtained with the request.
3INVALID API KEYProvided apikey is invalid.
4NO CHECKER IDchecker_id was missing.
5INVALID CHECKER IDchecker_id could not be recognized (no checker exists for the specified checker_id).
6INVALID REPORT IDreport_id was not recognized (no report exists for the specified report_id).
7REQUEST LIMIT EXCEEDEDYou have exceeded the limit of the API requests per minute, see "Usage" above.

Example error reaction

{"STATUS": "ERROR", "ERRNO": "3", "ERRTXT": "INVALID API KEY"}

Create a checker

URL / endpoint:

http://api.yourbrowser.is/create_checker

Request parameters

Parament namedescription
apikeyYour API key. Mandatory.
checker_idYour custom Checker ID. It will be included in the returned Checker URL. Mandatory.
checksA series of controls (registrations) that you can insert into the checker, in an order in which they should appear. See "Checks" below. Mandatory.
check_parametersSee "Check Parameters" below.
askIf you want the checker to get the user's consent * before you record the browsing environment data ("1") or to record the data directly when the page is loaded ("0"). Default value: "0".
redirect_urlURL to which you would like to redirect the user after the browsing environment data was recorded.
frame_urlURL to be displayed instead of the checker page. The checker page loads in an invisible frame. If set, the "Request" parameter is overwritten with "0".
callbackURL on which you want to receive the information (checker_id and report_id via POST) when a new report is recorded for a given check.
languageLanguage version of the checker page. If not set, the page is automatically displayed in the recognized language or in English if a language is not supported.
Currently supported languages: "en", "es", "fr", "de", "pl", "da", "ja", "zh".

* In the European Union (EU), the question of user consent is mandatory due to data protection regulations.

Checks

Detections listed below can be embedded in your checker:

Check nameCheck name
browserBrowser name & version.
operating_systemOperating system name & version.
mobile_deviceMobile device name.
screen_resolutionUser screen resolution.
current_viewportCurrent display size of the user (inner size of the browser window).
pixel_ratioCurrent size at which the web is displayed.
color_depthNumber of colors available.
javascriptJavaScript availability.
JavaJava availability & version.
flashFlash availability & version.
silverlightSilverlight availability & version.
cookiesCookie data availability.
ip_addressIP address of the user.
geolocationCountry, city and GPS coordinates of the user.
languageBrowser language of the user.
time_zoneTime zone of the user.
facebook_loginFacebook login status of the user. Doesn't work with custom domain.
google_loginGoogle account login status of the user.
ad_blockersAd blocker status.
connection_speedInternet download and upload speed on the receiving end. Not available if frame_url is set. Requires additional parameters, see below.
image_textInformative box to be displayed on your checker page. May contain text and a picture in the background. Not available if frame_url is set. Requires additional parameters, see below.
feedback_textfieldA form box to collect user feedback with a single line text field. Not available if frame_url is set. Requires additional parameters, see below.
feedback_textareaA form box to collect user feedback with a multi-line text field. Not available if frame_url is set. Requires additional parameters, see below.
feedback_dropdownA form box to collect user feedback with a drop down box. Not available if frame_url is set. Requires additional parameters, see below.
Check parameters

Some checks require additional parameters:

Check nameParament namevalues
connection_speedspeed_test_remoteSpecifies whether the connection speed should be measured by yourbrowser.is server ("0") or your server ("1", speed_test_server required). Default value: "0".
speed_test_serverURL of the connection speed test files on your server (for speed_test_remote = "1").
image_textlabelText to be displayed.
image_urlURL of the image to be displayed in the background, recommended dimensions: 250x250px.
feedback_textfieldfield_nameName for the field.
field_labelCaption to be displayed above the field.
feedback_textareafield_nameName for the field.
field_labelCaption to be displayed above the field.
feedback_dropdownfield_nameName for the field.
field_labelCaption to be displayed above the field.
valuesAvailable values, separated by ";", e.g. "Option 1; Option 2; Option 3".
multipleIf there should be multiple choices - "0" (no) or "1" (yes). Default value: "0".

Sample requests

{"apikey": "3q64v4u6vyu37a3fg", "checker_id": "mychecker427", "checks": ["operating_system", "browser"]}


{"apikey": "3q64v4u6vyu37a3fg", "checker_id": "mychecker428", "checks": ["operating_system", "browser", "connection_speed", "image_text", "feedback_textfield", "feedback_dropdown"], "check_parameters" : {"connection_speed": {"speed_test_remote": "1", "speed_test_server": "http://www.mywebsite.com/speedtest/index.html"}, "image_text": {"label": "We need to check your browser details to successfully provide support. "," image_url ":" http://www.mywebsite.com/image.png "}," feedback_textfield ": {" field_name ":" user-tries "," field_label ":" How many times did you try? " }, "feedback_dropdown": {"field_name": "user-problems", "field_label": "How frequently did the problem occur?", "values": "only once; a few times; many times; every time I tried "," multiple ":" 0 "}}," headers ":" 1 "," ask ":" 1 "," callback ":" http://www.mywebsite.com/my-callback-url ", "language": "en"}

answer

After successfully creating or updating the Checker, a status and the Checker URL are returned.
This URL should be passed on to the end user with the request to open it (confirm if "Ask" was set to "1").

Sample answers

{"STATUS": "CREATED", "URL": "http://mybrand.yourbrowser.is/mychecker427"}


{"STATUS": "UPDATED", "URL": "http://mybrand.yourbrowser.is/mychecker427"}

Get a list of reports

URL / endpoint:

http://api.yourbrowser.is/get_reports

Request parameters

Parament namedescription
apikeyYour API key. Mandatory.
checker_idChecker ID used at creation time (see "Creating a Checker" above). Mandatory.

Sample request

{"apikey": "3q64v4u6vyu37a3fg", "checker_id": "mychecker427"}

answer

This method will keep a list of reports from a particular checker.

properties

propertydescription
STATUSResponse status - see "Status" above.
CHECKERChecker ID.
REPORTSA list of the reports in the form of an array. See below the variables that are returned for each report.
Report variables
variabledescription
report_idUnique report ID.
createdDate and time the report was recorded, "YYYY-MM-DD UU: MM: SS", UTC / GMT.
ipIP address of the user who created the report.

Sample answers

{"STATUS": "OK", "CHECKER": "mychecker427", "REPORTS": []}


{"STATUS": "OK", "CHECKER": "mychecker427", "REPORTS": [{"report_id": "576a369aa19dd13", "created": "2016-06-22 6:56:26", "ip ":" 89.70.52.182 "}, {" report_id ":" 576a3c6092f3d14 "," created ":" 2016-06-22 7:21:04 "," ip ":" 89.70.52.182 "}, {" report_id " : "576a43daf320815", "created": "2016-06-22 7:52:58", "ip": "89.70.52.182"}]}

Get report details

URL / endpoint:

http://api.yourbrowser.is/get_report

Request parameters

Parament namedescription
apikeyYour API key. Mandatory.
checker_idChecker ID used at creation time (see "Creating a Checker" above). Mandatory.
report_idObtained the ID of the report from the report list (see "Getting a List of Reports" above). Mandatory.
headersSpecifies whether full HTTP headers should be included in the report ("1") or not ("0"). Default value: "0".

Sample request

{"apikey": "3q64v4u6vyu37a3fg", "checker_id": "mychecker427", "report_id": "576a369aa19dd13"}

answer

This method will return all saved user data in a single report.

properties

propertydescription
STATUSResponse status - see "Status" above.
CHECKERChecker ID.
REPORTReport ID.
CHECKSAn array of all the checks contained in the checker together with values. See below for possible values ​​that can be returned by certain checks.

Possible check values

Check namePossible values
http_headerFull HTTP headers from the user's browser, base64 encoded.
browserBrowser name & version.
operating_systemOperating system name & version.
mobile_deviceMobile device name.
screen_resolutionScreen resolution (depending on the pixel ratio), width x height in pixels.
current_viewportInner window size, width x height in pixels.
pixel_ratioPixel ratio.
color_depthNumber of colors.
javascript"1" (available) or "0" (not available).
JavaVersion number or "0" (not available).
flashVersion number or "0" (not available).
silverlightVersion number or "0" (not available).
cookies"1" (available) or "0" (not available).
ip_addressIP address.
geolocationCountry & City, GPS Latitude and GPS Longitude, separated by ";".
languageLanguage.
time_zoneTime zone, according to GMT.
facebook_login"1" (user logged on) or "0" (user not logged on).
google_login"1" (user logged on) or "0" (user not logged on).
ad_blockers"1" (ad blocker active) or "0" (ad blocker not active).
connection_speedDownload and upload speed in Mbps, separated by ";".
image_textNo real check, just an information field that can contain text and a picture.
feedback_textfieldText string entered in the text box by the user.
feedback_textareaText string entered by the user in the textarea field.
feedback_dropdownOption (s) selected by the user in the drop-down box, separated by a comma.

Sample answer

0 "}, {" check ":" operating_system "," value ":" Windows 8.1 "}, {" check ":" screen_resolution "," value ":" 1536x864 "}, {" check ":" current_viewport ", "value": "1519x710"}, {"check": "pixel_ratio", "value": "1.25: 1"}, {"check": "color_depth", "value": "24 bit"}, {" check ":" javascript "," value ":" 1 "}, {" check ":" java "," value ":" Version 1.8.0_91 "}, {" check ":" flash "," value ": "Version 22.0"}, {"check": "silverlight", "value": "0"}, {"check": "cookies", "value": "1"}, {"check": "ip_address" , "value": "89.70.52.182"}, {"check": "geolocation", "value": "Poland, Katowice; 50.2584; 19.0275"}, {"check": "language", "value": "Polish"}, {"check": "time_zone", "value": "GMT + 02: 00"}, {"check": "facebook_login", "value": "1"}, { "check": "google_login", "value": "1"}, {"check": "ad_blockers", "value": "0"}, {"check": "connection_speed", "value": "23.70 ; 17.17 "}, {" check ":" feedback_textfield "," value ":" lorem ipsum dolor "}, {" check ":" feedback_textarea "," value ":" lorem ipsum dolor \ nsit amet "}, {" check ":" feedback_dropdown "," value ":" Option 1, Option 3 "}]}

changelog

Version 1.1 - "language" query parameter added to create_checker.

Welcome product hunter! If you try the API, the first month is on us! Let us know.