IP SearchLight for ASP Classic - Online Documentation

 


IP SearchLight for ASP Classic (Quickstart)

Performance & Data Sources

Object Reference

Example Code

Licensing & Registration

   Registration

   License





IPSearchLight for ASP Classic


 

IPSearchLight for ASP Classic gives you real-time feedback on the geographic location of website visitors by their IP address alone.  The technology is completely uninvasive, yet can often track a person's location to a few miles radius on the planet.

Some potential IPSearchLight uses:


IPSearchLight for ASP Classic is an ActiveX Server Component.  It is packaged as a COM object and can be implemented with minimal code overhead.

Quickstart:

IPSearchLight is most easily installed by using the installer executable, which can be downloaded from http://www.ipsearchlight.com/asp_Download_Free_Trial.aspx.

Choose the directory you wish to install to (the given directory is recommended) and the installer will begin to extract and copy the database and other files.  If you choose a directory other than the default, you will need to specify that directory in your ASP code using the setDatabasePath function (see Object Reference for more details)

You can implement this on your site in only a few minutes using the Object Reference and the Example Source Code.  The example code is also made available in an ASP file, by the name "IPSearchLight_Test.asp ".  It can be found by using the Start Menu entry, or from the install directory in: C:\Program Files\IPSearchLight\Examples\IPSearchLight_Test.asp .



Please note that you will need the .Net Framework v1.1 (or greater) installed on your server to run this Component.


If you find that the data responses you're getting out of the IPSearchLight component are not sufficiently accurate, there is an upgrade option available.

 

Trial Registration

To use IPSearchLight for ASP Classic, a Registration Key is required.  If you have not yet purchased a Full License Key, download a Trial License Key from http://www.ipsearchlight.com/asp_Download_Free_Trial.aspx

The License Key will come in a txt file, and is good for 30 days of unrestricted use.  Specify the key value in your ASP code using the setLicenseKey function (see Object Reference for more details). 

To continue to use this component indefinitely, you will need to acquire a Full License Key from http://www.ipsearchlight.com/asp_Purchase_License.aspx

 

Installation Problems

If you experience an ASP Error "Invalid class string" due to recent windows security updates, then this can be easily fixed:


 



Performance & Data Sources


 

IPSearchLight uses the highest quality data provider available, MaxMind LLC. The database that comes packaged with IPSearchLight is MaxMind's GeoLiteCity. This is affordable and perfectly accurate for country detection and reasonably accurate at the regional and city level.  If you require a greater degree of accuracy, IPSearchLight facilitates two straightforward options:

  1. Purchase an Enterprise Database and optionally, successive updates from MaxMind LLC.
  2. Purchase access to a MaxMind's Enterprise WebService.

These two options offer the highest quality GeoLocation data available.  

 

Lite Database

This is the default, packaged solution.  When installing the IPSearchLight component, it is automatically installed to the following directory (by default): C:\Program Files\IPSearchLight\Database\GeoIPCity.dat

In ASP you can specify another location using the setDatabasePath method. 


Enterprise Database

The Full MaxMind GeoIPCity database is used in precisely the same manner as the Lite database.  It can be purchased directly from MaxMind.  Simply download the new database, and update the setDatabasePath  property accordingly.

 

Enterprise WebService

MaxMind also offer a WebService, which provides excellent quality.  Unless you expect an extremely high volume of traffic, this option delivers the best value. 

Buy MaxMind GeoIP City/ISP/Organization Web Service Queries online

When you've obtained your MaxMind WebService license key, use the setWebServiceKey method.  Using this key will override the use of any physical database installed.




 

Object Reference


 

Object Reference for COM object: IPSearchLight.GeoLocator

 

 

 

Set Methods

setLicenseKey(License_Key)

Use this method first.  It assigns your registration key for IPSearchlight.

This could be a Full License, or you can aquire a free 30 day Trial License key from http://www.ipsearchlight.com/asp_Download_Free_Trial.aspx .

setIPOrHost(IP_or_Host)

IP_or_Host is a string that specifies the IP Address or Host Name to be geographically looked up. 

For example: "216.239.37.99" or "http://www.google.com/"

If this parameter is not set, the GeoLocator will automatically detect your site visitors' IP addresses.

setDatabasePath(Database_Path)

Sets the full file path to the IPSearchlight Database File.

For example: "C:\Program Files\IPSearchLight\Database\GeoIPCity.dat" 

Use this method before using any of the Get Methods. 

If you have specified a Web Service Key, a physical database will be ignored.  If you would like this feature to work differently, please contact us at:  support@ipsearchlight.com

setWebServiceKey(Web_Service_Key)

Sets a MaxMind GeoIP City/ISP/Organization Web ServiceLicense Key.  When specified, it overrides Database_Path_or_URL and data is fetched across the internet instead.

 

 

Get Methods (geographically resolved against IP_or_Host)

 getIPOrHost

Gets the IP address of the current site visitor (or the IP address designated using setIP).

 getCountryCode

Country code using the ISO 3166 Country Code standard.  Returns variable of type 'BSTR'.

 getCountryName

Country name.  Returns variable of type 'BSTR'.

 getRegion

Region or state code.  For US and Canada, denotes state or province using ISO-3166-2 standard.  For all other nations, uses FIPS 10-4 code.  For example: "NY" or "Greater London".  Returns variable of type 'BSTR'.

 getCity

City or town name.  Returns variable of type 'BSTR'.

 getPostalCode

Zip/Postal Codes for US and Canadian Addresses.  Returns variable of type 'BSTR'.

 getLatitude

Latitude to 12 to a high degree of accuracy.  Returns variable of type 'double'.

 getLongitude

Longitude to 12 to a high degree of accuracy. Returns variable of type 'double'.

 getAreaCode

Three digit regional telephone code, for US lookups only.  Returns variable of type 'long'.

 getDMACode

Designated Market Area defined by code .  Returns variable of type 'long'.

 getStatus

Message designating the status of the component..  Returns variable of type 'BSTR'.

 getOrganization

Gets the organization name associated with the IP address.  Only available when using the Web Service .

 getISP

Gets the Internet Service Provider for the IP address.  Only available when using the Web Service .

 



Example Code in VBScript


 

This code is available in a file form in the examples folder at: C:\Program Files\IPSearchLight\Examples\IPSearchLight_Test.asp  (after you've run the installer) 

 

<%@LANGUAGE="VBSCRIPT" CODEPAGE="1252"%>

<%

set objIPSearchLight=server.createObject("IPSearchLight.GeoLocator")

objIPSearchLight.setLicenseKey("YOUR_LICENSE_KEY")     'Set your IPSearchLight Trial or Full License Key here.  Get a free trial license from: http://www.ipsearchlight.com/asp_Download_Free_Trial.aspx

'objIPSearchLight.setWebServiceKey("YOUR_WEBSERVICE_KEY")    '(optional) Set webservice key if you've purchased enterprise data queries from Maxmind.

'objIPSearchLight.setDatabasePath("YOUR_CUSTOM_DATABASE_PATH")   '(optional) Set the full path (including file name and extention) to your database file if you've installed it somewhere other than the default location.

objIPSearchLight.setIPOrHost("www.google.com")  '(optional) Set the host or IP address to locate. When not testing, do not call this function so that your visitor's location can be determined automatically using server variables.

Response.Write "IPOrHost: " & objIPSearchLight.getIPOrHost & "<br />"
Response.Write "CountryName: " & objIPSearchLight.getCountryName & "<br />
Response.Write "CountryCode: " & objIPSearchLight.getCountryCode & "<br />"
Response.Write "Latitude: " & objIPSearchLight.getLatitude & "<br />"
Response.Write "Longitude: " & objIPSearchLight.getLongitude & "<br />"
Response.Write "Region: " & objIPSearchLight.getRegion & "<br />"
Response.Write "City: " & objIPSearchLight.getCity & "<br />"
Response.Write "PostalCode: " & objIPSearchLight.getPostalCode & "<br />"
Response.Write "DMACode: " & objIPSearchLight.getDMACode & "<br />"
Response.Write "AreaCode: " & objIPSearchLight.getAreaCode & "<br />"
Response.Write "ISP: " & objIPSearchLight.getISP & "<br />"
Response.Write "Organization: " & objIPSearchLight.getOrganization & "<br />"
Response.Write "Status: " & objIPSearchLight.getStatus

%>



Registration


 

You will need to acquire a Trial or Full License Key from http://www.ipsearchlight.com/.

The license file should be assigned using the setLicenseKey method.

If you're having problems with this step, please contact us at support@ipsearchlight.com.



License


 

IPSearchLight.com hereby grants you a non-exclusive license to the IPSearchLight Software Component (the Software).  By downloading or using the Software, the Licensee agrees not to utilize the software in a manner which is disparaging to IPSearchLight.com, and not to rent, lease, distribute or otherwise transfer rights to the Software.
 
The Licensee agrees that no attempt will be made by the Licensee or associated parties to translate, reverse engineer, modify, decompile, disassemble or distribute the Software.
 
License terms are offered on the following terms, as purchased. If no purchase or insufficient purchase has been made then the Free Trial License terms apply.


FREE TRIAL LICENSE allows the use of the software by one developer for private evaluation purposes only.  The software should not be used for public or commercial use of any kind.  This trial should not be used for more than 30 days.

WEBSITE LICENSE allows the usage of the software on a single website.

SERVER LICENSE allows the usage of the software on a singe server.

ENTERPRISE LICENSE allows the usage of the software on any number of servers owned by one organization.


UPGRADES
If a new release of the software or its data-source are produced then you will be entitled to request  a free upgrade from IPSearchLight.com.  IPSearchLight.com does not guarantee any right to enhancement or update beyond the initial purchase, but will endeavor to offer upgrades and support wherever possible.

COPYRIGHT
The Software is protected by international copyright laws. Copyright for the GeoLite Databases and the associated API code remains with MaxMind LLC, NJ, USA  . All other title, ownership rights, and intellectual property rights in the Software is the property of IPSearchLight.com and may be protected by applicable copyright or other law. This License gives you no rights to such content.
 
LIMITATION OF LIABILITY.
THIS SOFTWARE IS PROVIDED "AS IS," WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. IPSEARCHLIGHT.COM AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL IPSEARCHLIGHT.COM  OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE SOFTWARE, EVEN IF IPSEARCHLIGHT.COM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 
MISCELLANEOUS
This software is not designed or intended for use in on-line control of aircraft, air traffic, aircraft navigation or aircraft communications; or in the design, construction, operation or maintenance of any nuclear facility. Licensee represents and warrants that it will not use or redistribute the Software for such purposes.