Blocker V2
Here is an example API documentation for the endpoint used for checking visitors status.
REQUEST
Endpoint
Method
Parameters
apikey
(string, required): The API key provided to the user.ip
(string, required): The IP address of the visitor.ua
(string, required): The useragent used by the visitor.url
(string, required): The URL opened by the visitor, REQUEST_URI from your Website/Apps).confname
(string, required): The configuration name obtained from STOPBOT.NET Blocker V2.params
(string, required): The parameters are received from your Website/Apps and converted the parameter array into JSON.headers
(string, required): The headers are received from your Website/Apps and converted the headers array into JSON.
Example Request
Example Response
Success Response
If the HTTP response is 200 (success response), it will generate the following response:
Description on successful response
IP
: The visitor's IP address.UA
: The useragent used by the visitor.IPInfo
: Information about the visitor's IP.hostname
: The visitor's hostname.asn
: The Autonomous System Number (ASN) that identifies the internet service provider.company
: The company associated with the visitor's IP.isp
: The Internet Service Provider (ISP) name.city
: The city where the visitor is located.district
: The district or area associated with the IP address.region
: The region where the visitor is located.postcode
: The postal code associated with the IP address.country
: The country where the visitor is located.latitude
: The latitude coordinate of the IP address location.longitude
: The longitude coordinate of the IP address location.timezone
: The timezone of the IP address location.
Status
: Information about the visitor's IP status.Bot
: Indicates whether the visitor is a bot (1) or not (0).Block
: Indicates whether access is blocked (1) or not (0).ThreatURL
: Indicating whether the visitor is performing suspicious actions on your URL, result true (1) or false (0).Desc
: Description status.
PageResponse
: Information about the response page.Type
: indicates that the response type is :None : Stay on Page.
RedirectURL : It's a signal that you should redirect the request to a specific URL provided in the
Contents
field as a way to mitigate or handle bot-related activity.
Contents
: Response contents.
status
: Indicates the success or failure of the request.timeResponse
: Date and time when the response was sent.
Failed Response
If the HTTP response is 400 or 401 (failed response), it will generate the following response:
Description on failed response:
status
: Response Status: The value is "errors" if the request fails.message
: Error message.timeResponse
: Date and time when the response was sent.
Last updated