IsValid - WebsiteValidation • Data8 Web Services API Documentation

IsValid

Checks if a website address is valid.

Description

Checks a website address for validity.

The service will attempt to validate the supplied web address with and without a leading www.

If the supplied value does not contain a URL scheme (http:// or https://), http will be used.

If any additional part of a URL is supplied it will be ignored. Only the domain is validated.

If the supplied website uses any redirections, the final domain name after following those redirections will be used as the host name in the returned value. Note that if the website uses different redirections for different client languages or IP addresses, the returned host may be different to the one you see if you navigate to the website yourself. For example, if you go to google.com you may be redirected to google.co.uk, google.fr, google.de etc. depending on where you are requesting the page from.

Because this service is doing a live check on the Internet it can take a few seconds to get a response.

Endpoint URLs

To connect to this service you'll need to use one of these endpoints:

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/WebsiteValidation/IsValid.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/WebsiteValidation/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/websitevalidation.asmx

Parameters

The following parameters can be supplied to this method:

Name	Description
username	username See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix `apikey-`, e.g. `apikey-ABCD-1234-EFGH-5678`
password	password If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
domain	domain The web address to validate.
options	options An array of options that control further details of how this method operates. See the `Advanced Options` section below, for more information.

Advanced Options

The following options can be specified as part of the option parameter. Each option is specified as a key/value pair. The list of available names is shown below, along with a description of the allowable values for that name.

Name	Description
Common Options
ApplicationName	ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard.

Results

This method returns an object containing the following fields:

Name	Description
Status	Status Indicates whether the method call was successful, or if some error occurred. If the `Success` field is `true`, the other results described below can be used to get the results of the method. If `Success` is `false`, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the `ErrorMessage` field, and any other results should be ignored.
Valid	Valid Indicates if the website is valid
Host	Host Contains the full host name of the validated website, e.g. `www.data-8.co.uk`
Tld	Tld Contains the top level domain of the validated website, i.e. without any leading www or other subdomain information

Credit Usage

Each request to this method consumes 1 WebsiteValidation credit.

Sample Code

Request Format

{
  "domain": "data-8.co.uk",
  "options": {}
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Valid": null,
  "Host": null,
  "Tld": null
}

Depending on your chosen authentication method you will need to modify this request slightly:

API Key

Post the request to
https://webservices.data-8.co.uk/WebsiteValidation/IsValid.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
domain	domain
Common Options
ApplicationName	ApplicationName
Credits Remaining Today: 5 Try It Now!