The IXI Digital resolution system allows you to easily map an IP address to the IXI Dataset in real-time.
The best way to start experimenting is to start exploring the code below.


Authorization Key
You will need to register and retrieve a key in order to access the IXI Digital API.  
Please enter or paste your authorization key here:


     Not registered yet? Click here to request an authorization key.

Right click to DOWNLOAD THIS PAGE AS A TEXT FILE


Usage           Code in italics is optional. Bold is used simply to visually separate items

1. http://<environment>/digi/{auth_key}/a.gif?ip={clientip}&z9={z9 code}&callback={callback_url}&AA={AA_value}
&AB={AB_value}
&AC={AC_value}&AY={AY_value}&AZ={AZ_value}&EA={EA_value}&EB={EB_value}&EC={EC_value}
&ED={ED_value}&EE={EE_value}

2. http://<environment>/digi/{auth_key}/a.js?ip={clientip}&z9={z9 code}&callback={callback_url}&AA={AA_value}
&AB={AB_value}
&AC={AC_value}&AY={AY_value}&AZ={AZ_value}&EA={EA_value}&EB={EB_value}&EC={EC_value}
&ED={ED_value}&EE={EE_value}

3. http://<environment>/digi/{auth_key}/jsonp.html?jsonp=a


Environment

Replace <environment> in the URLs above with

test.ixiaa.com: Test Server - Please use during test or pilot phase.

s.ixiaa.com: Production Server – Please use in production.
    You will not have access to the production environment during the test or pilot phase.


Required Parameters

auth_key = Contains the IXI issued authorization key of the requester. The key has an expiration date.
    The key identifies the measures that the requester is licensed for.

Optional Parameters

ip = The Client IP if available.

z9 = The Z9 Code if available.

redirect = The URL to redirect to

callback = The URL to send any information to

jsonp = The javascript variable to return.

Return Types

1. Redirect URL
Example:
http://<environment>/digi/{auth_key}/a.gif?ip={clientip}&redirect={ http://www.thepartner.com/someservice?partnerid=IXI&AA=16&AB=4&AC=56&AY=1&...}

http://<environment>/digi/{auth_key}/a.js?ip={clientip}&redirect={ http://www.thepartner.com/someservice?partnerid=IXI&AA=16&AB=4&AC=56&AY=1&...}

Technical:-  Goal is to provide interested parties access to a browser which they otherwise won't have along with IXI digital segment information about the browser. In this case also usually an empty .gif is returned back to the browser.

2. Empty .gif file
Example: - http://<environment>/digi/{auth_key}/a.gif

Technical :-  Place a 1x1  IXI pixel on the site for the ad(s) you are trying to target. IXI will log the information sent on the URL and return an empty .gif back. Users can send any information on the URL. For e.g. offer, goal, campaign type etc.

3. JSON Object
Example: - http://<environment>/digi/{auth_key}/a.js
{"AA":"7","AB":"2","AC":"44","AY":"1","AZ":"1","EA":"3","EB":"3","EC":"63","ED":"1","EE":"3"}

Technical :- Return digital segments back in a JSON format.

4. Wrapped JSONP Object
Example:
http://<environment>/digi/{auth_key}/jsonp.html?jsonp=a
<script type="text/javascript" src="http://<environment>/digi/{auth_key}/jsonp.html?jsonp=a"></script>

Technical:- Sometimes a browser will want to request data from a server in a different domain to display on the page, or make a decision about which ad to show based on the data from another server. For example, a Site creator may want to display an RSS feed from Twitter on the page but their page is not hosted on the same server as Twitter. Trying to get a straight up JSON response back will give the security error because the domain of the requested URL must be same as the domain of the current webpage. Using the JSONP technique overcomes these limitations and allows for cross domain communication. The return type is in JSON format.

5. Callback URL
Example:
http://<environment>/digi/{auth_key}/a.gif?ip={clientip}&callback={ http://www.thepartner.com/someservice?partnerid=IXI&AA=16&AB=4&AC=56&AY=1&...}
http://<environment>/digi/{auth_key}/a.js?ip={clientip}&callback={ http://www.thepartner.com/someservice?partnerid=IXI&AA=16&AB=4&AC=56&AY=1&...}

Technical :- Can be used for server to server sync. The digital segments will be sent back to the server specified in the callback URL. The request is asynchronous and doesn't hold up resources on either side of the call.


Note:- Measures not licensed for the submitted authorization key will have the value β€œNA”.