API Functions Guide

API Functions Guide

The following documentation outlines the API Functions available on the Xortify Honeypot. You can use this guide to help you develop your own solution to SPAM, Harvesting and malicious attacks to your website.

API Functions List

• [ban] - This function is used to raise a banned IP Locality or Network Details.
• [ban_diff] - This function is used for comparing ban lists between server nodes.
• [banned] - This function is for testing if an item is currently banned.
• [bans] - This function retrieves the current ban list in a number of amount.
• [checkphpbans] - This function returns http://ProjectHoneypot.org IP information on a IPv4 address.
• [checksfsbans] - This function returns a result from http://StopForumSpam.com repository.
• [cloud_users] - Retrieves a list of users on the cloud, by start and limited listing.
• [cloud_users_count] - Return the number of uses on the Xortify Server Node.
• [comments] - Returns comment against banned and unbanned items.
• [languages] - Returns a list of available languages on the Service Node.
• [rep_spider] - Reports updated information on a crawler or spider.
• [rep_spiderstat] - Reports updated spider statistics.
• [seolinks] - Retrieves a block of links spidered recently by the spiders client.
• [server] - Retrieves a details of identified Xortify Server listed in the node.
• [server_create_user] - Creates a username with password for a Xortify Server Node.
• [servers] - Retrieves a list of servers available and listed in the Server Node.
• [sfsban] - Creates a ban on http://StopForumSpam.com.
• [spamcheck] - Checks if content is spam or ham.
• [spider] - Modifies a Spider or Crawler Listing.
• [spiders] - Retrieves a detailed list of spiders, crawlers and bots white-listed on the server.
• [spiderstat] - Used to report a spider statistic on the cloud.
• [spoofcomment] - Retrieves a spoof/fake banning comment form.
• [spoofregistration] - Retrieves a spoof/fake banning registration form.
• [spoofthread] - Retrieves a spoof/fake banning thread form.
• [training] - Allows you to provide spam and ham samples and further train the [spamcheck] function.
• [unbanned] - Check if [ipdata] is listed in Unbans.
• [unbans] - Checks for network information is contained within the unbanned items listing.
• [xoops_authentication] - Checks for username and password information to authenticate.
• [xoops_check_activation] - Checks an activation code of a user for new user registration.
• [xoops_create_user] - Create a new Client Username on the Xortify Service Node.
• [xoops_network_disclaimer] - Gets Service Nodes New User Registration Disclaimer.
• [xoops_user_validate] - Validates Client User details before creating a new user.

API Response Cache

On all the possible methods of calling the API apart from inclusive of SOAP, the response from the service is cached for 20 minutes after the intial call, that means each unique call to the Service node is buffered for 20 minutes and replies with the same response for this period, this is to stop duplicate and shadow calling of the API.