Validate ZoneID Documentation

Shared Validate Throttle: 500/Hour

Object: ZoneID

Zone Identifier

print
Object: Print

Example

"print": {
	"uri": "%25%F0%9F%92%A9",
	"iri": "%25💩"
}
encoding
Object: Encoding

Example

"encoding": {
	"unicode": true
}
zoneid
String
ZoneID

Example

"zoneid": "💩"
correct
Boolean
Was Input Correct to the Spec?

Example

"correct": true

Object Examples: ZoneID

ASCII + Unnecessarily Encoded Input: "%25%65%74%68-._~"
{
	"print": {
		"uri": "%25eth-._~",
		"iri": "%25eth-._~"
	},
	"encoding": {
		"pe-unnecessary": true
	},
	"zoneid": "eth-._~"
}
Invalid ASCII Character Input: "%25!"
{
	"print": {
		"uri": "%25%21",
		"iri": "%25%21"
	},
	"encoding": {
		"pe-invalid": true
	},
	"zoneid": "!"
}
Unicode Input: "%25💩"
{
	"print": {
		"uri": "%25%F0%9F%92%A9",
		"iri": "%25💩"
	},
	"encoding": {
		"unicode": true
	},
	"zoneid": "💩",
	"correct": true
}
Percent Encoding Input: "%25%F0%9F%92%A9"
{
	"print": {
		"uri": "%25%F0%9F%92%A9",
		"iri": "%25💩"
	},
	"encoding": {
		"pe-necessary": true
	},
	"zoneid": "💩",
	"correct": true
}

Object: ZoneID_Options

POST APIs only support setting Options. Attributes are displayed when set to true.
GET APIs return the Default set Options.
print
Object: Print_Options
labels
Object: Encoding_Options
zoneid
Boolean
correct
Boolean

Object Examples: ZoneID_Options

Default Options:
{
	"print": {
		"uri": true,
		"iri": true
	},
	"encoding": {
		"cleaned": true,
		"unicode": true,
		"pe-necessary": true,
		"pe-unnecessary": true,
		"pe-partial": true,
		"pe-invalid": true
	},
	"zoneid": true,
	"correct": true
}

Object: Print

uri
String
URI Output

Unicode and Unsafe ASCII Characters are Percent Encoded

Example

"uri": "ascii"
"uri": "%25" // ascii % character
"uri": "%F0%9F%98%BB" // 😻
iri
String
IRI Output

Unicode is Unencoded, Unsafe ASCII Characters are Percent Encoded

Example

"iri": "unicode"
"iri": "%25" // ascii % character
"iri": "😻"

Object Examples: Print

ASCII Input: "%25eth-._~"
{
	"uri": "%25eth-._~",
	"iri": "%25eth-._~"
}
Unicode Input: "%25💩"
{
	"uri": "%25%F0%9F%92%A9",
	"iri": "%25💩"
}

Object: Print_Options

POST APIs only support setting Options. Attributes are displayed when set to true.
GET APIs return the Default set Options.
uri
Boolean
iri
Boolean

Object: Encoding

cleaned
Boolean
Was the Input Cleaned?
Control Character or other Blacklisted Characters may be removed!

Example

"cleaned": false
unicode
Boolean
Did the Input contain Unicode?

Example

"unicode": true
pe-necessary
Boolean
Did the Input contain Percent Encoding - was a Character Necessarily Encoded?

Example

"pe-necessary": false
pe-unnecessary
Boolean
Did the Input contain Percent Encoding - was a Character Unnecessarily Encoded?

Example

"pe-unnecessary": false
pe-partial
Boolean
Did the Input contain Percent Encoding - was a Unicode Character Partially Encoded?

Example

"pe-partial": false
pe-invalid
Boolean
Did the Input contain an Invalid Character that should have been Percent Encoded?

Example

"pe-invalid": false

Object Examples: Encoding

ASCII Input: "%25!%65%74%68%21"
{
	"pe-necessary": true,
	"pe-unnecessary": true,
	"pe-invalid": true
}
Unicode Input: "%25💩"
{
	"unicode": true
}
Percent Encoding Input: "%25%F0%9F%92%A9"
{
	"pe-necessary": true
}

Object: Encoding_Options

POST APIs only support setting Options. Attributes are displayed when set to true.
GET APIs return the Default set Options.
cleaned
Boolean
unicode
Boolean
pe-necessary
Boolean
pe-unnecessary
Boolean
pe-partial
Boolean
pe-invalid
Boolean

POST /api;v1.0/validate/zoneid

JSON POST endpoint. Supports Validator Options!

Request

Parameters

raw
String
Raw Input to Validate

Example

"raw": "http://juandefu.ca/"
validator
Number
Optional
Method of Validation to use.
STRICT Validation will not allow Incorrect Spec Validation to occur! It's recommended to use LOOSE!
LOOSE_ASIS assumes percent encoding DOES NOT EXIST and any percent characters will be encoded!

The Default/Invalid Validator is LOOSE

Constants

Key Value
STRICT 1
LOOSE 2
LOOSE_ASIS 3


Example

"validator": 0
options
Object: ZoneID_Options
Optional
Validator Options
Default Options will be used when nil

shorten
Boolean
Optional
Shorten Validated Object
Shortened Object may include other URI Compments needed to create a Valid URI Object
Validated must be Valid and Shorten must not be Throttled!

Example

"shorten": true
shorten-private
Boolean
Optional
If this is set you will only be able to access the Shortened Link with a Private Key!
Private is a very large Random Integer up to 2^64 (18,446,744,073,709,551,615) and should be very hard to brute force!
DO NOT RELY SOLEY ON THIS FOR SECURITY!

Example

"private": true

Response

errors
[]String
This is only returned on Internal Errors! Always check the Response Header Content-Type before parsing!

Example

"errors": [
	"internal server error"
]
shortened
Object: Shortened
If Validated is Throttled or an error occurs Shortened will be ignored!

validated
Object: ZoneID
Always returned!

If Throttled, returns an Object containing the Attribute "throttle" with a value of the Throttle Expiration Timestamp RFC 3339


GET /api;v1.0/validate/zoneid

GET endpoint that only uses Query String Parameters. Supports JSONP!
Content must be properly encoded to fit within the Query String Field Variable "raw"!

Request

Parameters

raw
String
Raw Input to Validate

Example

"raw": "http://juandefu.ca/"
validator
Number
Optional
Method of Validation to use.
STRICT Validation will not allow Incorrect Spec Validation to occur! It's recommended to use LOOSE!
LOOSE_ASIS assumes percent encoding DOES NOT EXIST and any percent characters will be encoded!

The Default/Invalid Validator is LOOSE

Constants

Key Value
STRICT 1
LOOSE 2
LOOSE_ASIS 3


Example

validator=2
shorten
Exists
Optional
Shorten Validated Object
Shortened Object may include other URI Compments needed to create a Valid URI Object
Validated must be Valid and Shorten must not be Throttled!

shorten-private
Exists
Optional
If this is set you will only be able to access the Shortened Link with a Private Key!
Private is a very large Random Integer up to 2^64 (18,446,744,073,709,551,615) and should be very hard to brute force!
DO NOT RELY SOLEY ON THIS FOR SECURITY!

jsonp
String
Optional
JSONP will be used to pad the JSON payload with a Function.
Must be a-zA-Z and 15 characters or less.
If JSONP is set and is empty or invalid "ZeroOut" will be used!

Example

jsonp=Whoa
Whoa({});
pd
Exists
Optional
Should Input be Percent Decoded before being passed to the Validator?
Most Validators will do their own Percent Decoding of Input.
This should only be used if necessary or if the Validator does not support Percent Decoding.

Response

errors
[]String
This is only returned on Internal Errors! Always check the Response Header Content-Type before parsing!

Example

"errors": [
	"internal server error"
]
shortened
Object: Shortened
If Validated is Throttled or an error occurs Shortened will be ignored!

validated
Object: ZoneID
Always returned!

If Throttled, returns an Object containing the Attribute "throttle" with a value of the Throttle Expiration Timestamp RFC 3339


GET /api;v1.0/validate/zoneid/after?

GET endpoint that uses Directory Parameters and the whole content of Query String (?) as the Raw Parameter. Supports JSONP!
This is useful if you are unsure or unable to properly encode a Query String Variable.
This will not support Fragments if # is not encoded! Fragments are client side only!
Variables are appended to the Directory 'after' with the ; Delimiter and before the Query String! Order of parameters is not important.
Example:
Request: /api;v1.0/validate/zoneid/after;jsonp=Whoa;shorten;validator=2?%25zoneid
Parameters: ;jsonp=Whoa;shorten;validator=2
Validate: %25zoneid

Request

Parameters

validator
Number
Optional
Method of Validation to use.
STRICT Validation will not allow Incorrect Spec Validation to occur! It's recommended to use LOOSE!
LOOSE_ASIS assumes percent encoding DOES NOT EXIST and any percent characters will be encoded!

The Default/Invalid Validator is LOOSE

Constants

Key Value
STRICT 1
LOOSE 2
LOOSE_ASIS 3


Example

validator=2
shorten
Exists
Optional
Shorten Validated Object
Shortened Object may include other URI Compments needed to create a Valid URI Object
Validated must be Valid and Shorten must not be Throttled!

shorten-private
Exists
Optional
If this is set you will only be able to access the Shortened Link with a Private Key!
Private is a very large Random Integer up to 2^64 (18,446,744,073,709,551,615) and should be very hard to brute force!
DO NOT RELY SOLEY ON THIS FOR SECURITY!

jsonp
String
Optional
JSONP will be used to pad the JSON payload with a Function.
Must be a-zA-Z and 15 characters or less.
If JSONP is set and is empty or invalid "ZeroOut" will be used!

Example

jsonp=Whoa
Whoa({});
pd
Exists
Optional
Should Input be Percent Decoded before being passed to the Validator?
Most Validators will do their own Percent Decoding of Input.
This should only be used if necessary or if the Validator does not support Percent Decoding.

Response

errors
[]String
This is only returned on Internal Errors! Always check the Response Header Content-Type before parsing!

Example

"errors": [
	"internal server error"
]
shortened
Object: Shortened
If Validated is Throttled or an error occurs Shortened will be ignored!

validated
Object: ZoneID
Always returned!

If Throttled, returns an Object containing the Attribute "throttle" with a value of the Throttle Expiration Timestamp RFC 3339