16. FAQ¶
Contents
- FAQ
- Do I need the JavaScript library from Equifax to consume REST API services ?
- How do I resolve the Same Origin Policy constraints
- Can I run javascript from localhost or local PC without a webserver
- Can I use JSONP to read XML data
- Do you support CORS
- How to run javascript from a localhost
- Can I develop my C# or Java Rest API client to consume API services?
- Is the endpoint URLs case sensitive
- Who do I contact for support?
- How do I test connectivity. Do you support Ping Operations
- Do you have SOAP based web service ?
- Do you have a WSDL?
- How many HTTP sessions can be opened at a time
- Is there a HTTP session timeout. If so, what is the time out ?
- Do you support POST method
- What constitutes a billable transaction
- What are Equifax Variables and what do they mean
- Do you have a downloadable example to get me started.
- Is there a test environment? How do I access it?
- Who do I contact to sign up for the service?
16.1. Do I need the JavaScript library from Equifax to consume REST API services ?¶
No. You can use standard JavaScript functions like XMLHttpRequest which is supported natively on most modern browsers or you may use libraries like jQuery for sending REST API requests.
16.2. How do I resolve the Same Origin Policy constraints¶
Same Origin Policy (SOP) does not permit scripts running on a web page originating from a different site. That means if you are accessing REST APIs from Equifax directly from a web page served from your company domain or localhost, SOP will block that request being sent to http://services.inivio.com.au domain.
We recommend you use JSONP to resolve this restriction. JSONP will overcome the XMLHttpRequest same origin/domain policy restriction. Typically libraries like Jquery will make the JSONP implementation easier.
Note for AngularJS developers . If you are using AngularJS to develop your client side code for the Address Auto-Complete (Typeahead) APIs which use referer, you need to include callback=JSON_CALLBACK in the url. That this is not an REST API from Equifax requirement, but a common programming practice for AngularJS.
See the answers to these question for additional information
16.3. Can I run javascript from localhost or local PC without a webserver¶
Same Origin Policy issues prevent you to do this normally. See the answer to this question on SOP. If you are using JSONP and if you need to run the javascript from a localhost or if you are opening the webpage from your computer file system, you need to set the referer field in the HTTP header programmatically. The value you set in the header needs to be set as the Referer in the portal. See this section on how to do add your domain. This is not recommended for production and may be used for development testing from a local computer.
16.4. Can I use JSONP to read XML data¶
JSONP has really nothing to do with JSON data. You can use JSONP to read XML data if you have requested the data to be returned in XML data format. You need to parse the received XML string in javascript
16.5. Do you support CORS¶
No. We recommend you use JSONP. JSONP supports only GET operation. Since all APIs which use Referer (Whitelist) method use GET, we recommend that you use JSONP.
16.6. How to run javascript from a localhost¶
If you are executing the javascript on a webpage served by the webserver running on your local machine, or, if the webpage is opened from a local computer file system without a webserver, you need to add the hostname of your computer to the API configuration page. See this section on how to do this.
You can find the hostname using hostname or ipconfig/all command.
Tip
So if hostname is asus2 and your html page is my_page_with_autocomplete.html, then address of the web page (URL) on your local PC should be http://asus2/my_page_with_autocomplete.html and not http://localhost/my_page_with_autocomplete.html
16.7. Can I develop my C# or Java Rest API client to consume API services?¶
Yes you can, the API is a standard RESTful web service.
16.8. Is the endpoint URLs case sensitive¶
No. The URLs and method names are not case sensitive.
16.10. How do I test connectivity. Do you support Ping Operations¶
Yes , Ping operators are available for all APIs :
- Autocomplete/Address Validation: https://services.inivio.com.au/autocomplete/address/ping=autocompleteTest
- Phone Validation: https://services.inivio.com.au/validate/phonenumber/ping=phoneTest
- Email Validation: https://services.inivio.com.au/validate/email/ping=emailTest
- Audience Enhancement: https://services.inivio.com.au/enhance/address/ping=enhanceTest
16.11. Do you have SOAP based web service ?¶
These specific APIs are currently not available on SOAP, however, we are actively working towards making these available. Please get in contact with us to discuss SOAP options.
16.12. Do you have a WSDL?¶
As these specific APIs are not available on SOAP, there are no WSDLs available. However, we do have similar APIs available on SOAP which may cater to your needs. Please get in contact with us to discuss SOAP options.
16.13. How many HTTP sessions can be opened at a time¶
The Marketing Portal by Equifax services support autoscaling, however the maximum number of concurrent sessions is 10 per instance.
16.14. Is there a HTTP session timeout. If so, what is the time out ?¶
The default timeout is 1 minute.
16.15. Do you support POST method¶
No. Only HTTP GET is supported.
16.16. What constitutes a billable transaction¶
For standard Address services
The final call to select a suggested address eg GET ../ ValidateAddress?address is a billable transaction
For other Validation Services including Phone & Email
Every successful call to the service eg GET .. /phonenumber?value=0408xxxxxx&carrier=true
Phone Validation – For every successful Phone Validation call, the following responses constitute a billable transaction:
Status Code | Status | Chargeable? |
---|---|---|
100 | QUEUED | N |
200 | CONNECTED | Y |
300 | DISCONNECTED | Y |
400 | INDETERMINATE | Y |
-1 | INVALID | Y |
-2 | ERROR | N |
0 | UNKNOWN | N |
N/A | Carrier Appended | Y |
Email Validation – For every successful Email Validation call, the following responses constitute a billable transaction:
Status Code | Chargeable? |
---|---|
VALID | Y |
INVALID | Y |
UNCERTAIN | Y |
UNKNOWN | Y |
EXCEPTION | N |
16.17. What are Equifax Variables and what do they mean¶
See inivio_variables. To better understand the Audience Enhancement service more, click here
16.18. Do you have a downloadable example to get me started.¶
No, but you can see examples on equifax.com.au/datadrivenmarketing/landscape
16.19. Is there a test environment? How do I access it?¶
Test credentials are available to access Stubbed and Sandbox data. When the test credentials are submitted in a Basic Authentication API endpoint, a predefined set of test data will be returned in the stubbed / sandbox responses. There is no separate environment for testing as we wanted to make the transition of Test to Production easiest for you. All code will remain the same, all you need to do is substitute the test credentials with your Production credentials when they have been acquired.
To request for the test credentials, contact your Pre-Sales / Sales Manager for the documentation. Alternatively, send us an email on datadrivenmarketingAU@equifax.com
16.20. Who do I contact to sign up for the service?¶
If you would like to access our suite of services in Production, simply fill out our registration form