Skip to content
This repository has been archived by the owner on Feb 22, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updating naming and adding in links to grab a token
  • Loading branch information
almills committed Nov 27, 2015
1 parent 30bceff commit 1893e05
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Contact Data Services
# Our Real Time Address API

[![GitHub version](https://badge.fury.io/gh/ExperianDataQuality%2Fcontactdataservices.svg)](http://badge.fury.io/gh/ExperianDataQuality%2Fcontactdataservices)
[![Dependency Status](https://david-dm.org/ExperianDataQuality/contactdataservices.svg)](https://david-dm.org/ExperianDataQuality/contactdataservices)
[![Dependency Status](https://david-dm.org/ExperianDataQuality/contactdataservices/dev-status.svg)](https://david-dm.org/ExperianDataQuality/contactdataservices#info=devDependencies)
[![Build Status](https://travis-ci.org/experiandataquality/contactdataservices.svg?branch=master)](https://travis-ci.org/experiandataquality/contactdataservices)

This repo contains sample code for integrating with Experian Data Quality's Contact Data Services. Currently set up for typedown address searching for GBR, USA, AUS, NZL and FRA.
This repo contains sample code for integrating with Experian Data Quality's Address API. Currently available for GBR, USA, AUS, NZL and FRA.

## Usage

#### Prerequisites

- Include the Contact Data Services [JavaScript file](https://github.com/experiandataquality/contactdataservices/blob/master/dist/js/contact-data-services.min.js) in your form page.
- Include the Real Time Address API [JavaScript file](https://github.com/experiandataquality/contactdataservices/blob/master/dist/js/contact-data-services.min.js) in your form page.
- Have a token to hand (You would have received this from your Experian Data Quality account manager).

#### Integration
Expand All @@ -20,6 +20,8 @@ This repo contains sample code for integrating with Experian Data Quality's Cont

> For the purpose of this sample code, the tokens for the live endpoint aren't hardcoded in source control and must be appended to the URL query string. For example: **http://localhost/?token=xyz**
To get a free trial, contact us via [edq.com](http://www.edq.com)

##### Options

Some customisable settings can be passed through to the API using an options object. By default you should at least pass through an `elements` object with the address field input and country list selectors.
Expand Down

0 comments on commit 1893e05

Please sign in to comment.