How the API Functions

The api functions with the end client or website packaging a JSON Package into a function name on the API below the function names are called but in a URL such a call would look like following:

xortify.com/json/?bans={"username":"testuser","password":"password","records":1200}

Or the password can be sent as an MD5 Hash which you can get from programs like hashcalc from www.slavasoft.com (as seen below)

xortify.com/json/?bans={"username":"testuser","password":"5f4dcc3b5aa765d61d8327deb882cf99","records":1200}

This for example will retrieve the bans off the port with 1200 of the top records. As you can see it is calling the function bans with a JSON package containing the Username,Password and number of Records exhibitted by the function. below is a list of functions and the formed array to send in a JSON package, this is done for both the wGET and cURL interface, you can POST the data to the URL with the function name as the pakage field with the array encoded in JSON for the function call.

Functions on the API

ban

This function takes an array of bans with a username and password and replies with a made request. It is used for listing bans on the network and ensures you have a seemless entry to listing bans on the Xortify cloud. The function is broken down into the following JSON package fielded array:

1. username (string)
2. password (string)
3. bans (array) - below is the ban array construct tabbed
   1. category_id (integer) - category id for ban contact us if you need one!
   2. email (string) - email of the offender (not required)
   3. uid (integer) - user id number of the offender (not required)
   4. uname (string) - username of the offender (not required)
   5. ip4 (string) - IPv4 Tcp/ip protcol address (requires either ip4 or ip6)
   6. ip6 (string) - IPv6 Tcp/ip protcol address (requires either ip4 or ip6)
   7. long (integer) - Network Long integer pointer (not required)
   8. proxy-ip4 (string) - Proxy IPv4 TCP/IP Protocol address (not required)
   9. proxy-ip6 (string) - Proxy IPv6 TCP/IP Protocol address (not required)
   10. network-addy (string) - Netbios network name (Required)
   11. mac-addy (string) - MAC network addresses for banning hardware (not required)
   12. made (integer) - Unix Date Stamp of when the ban was named GMT10 (Required)
4. comments (array) - below is the ban comment array construct tabbed out. (not required)
   1. uid (integer) - your xortify user id number (see profile string) (not required)
   2. uname (string) - your xortify username (not required)
   3. comment (string) - user if id number of the offender (not required)

if you are looking for some code example here in PHP is a function that will construct the associative array that is used for constructing a node or details for a ban for XOOPS:

bans

This function returns an array of bans with a username and password and replies with a made request. It is used for retrieving bans on the network and ensures you have a seemless entry to retieving bans on the Xortify cloud. The function is broken down into the following JSON package fielded array:

1. username (string)
2. password (string)
3. record (integer)

unbans

This function returns an array of unbans with a username and password and replies with a made request. It is used for retrieving bans on the network and ensures you have a seemless entry to retieving bans on the Xortify cloud. The function is broken down into the following JSON package fielded array:

1. username (string)
2. password (string)
3. records (integer)

banned

This function takes an associative array of ip ban data with a username and password and replies with a record and whether the details are currently banned. It is used for listing bans or checking if details are banned on the network and ensures you have a seemless entry to listing bans on the Xortify cloud. The function is broken down into the following JSON package fielded array:

1. username (string)
2. password (string)
3. pdata (associatve array) - below is the ban array construct tabbed
   1. email (string) - email of the offender (not required)
   2. uname (string) - username of the offender (not required)
   3. ip4 (string) - IPv4 Tcp/ip protcol address (not required)
   4. ip6 (string) - IPv6 Tcp/ip protcol address (not required)
   5. long (integer) - Network Long integer pointer (not required)
   6. proxy-ip4 (string) - Proxy IPv4 TCP/IP Protocol address (not required)
   7. proxy-ip6 (string) - Proxy IPv6 TCP/IP Protocol address (not required)
   8. network-addy (string) - Netbios network name (not required)

unbanned

This function takes an associative array of ip ban data with a username and password and replies with a record and whether the details are currently unbanned. It is used for listing unbans or checking if details are unbanned on the network and ensures you have a seemless entry to listing bans on the Xortify cloud. The function is broken down into the following JSON package fielded array:

1. username (string)
2. password (string)
3. pdata (associatve array) - below is the ban array construct tabbed
   1. email (string) - email of the offender (not required)
   2. uname (string) - username of the offender (not required)
   3. ip4 (string) - IPv4 Tcp/ip protcol address (not required)
   4. ip6 (string) - IPv6 Tcp/ip protcol address (not required)
   5. long (integer) - Network Long integer pointer (not required)
   6. proxy-ip4 (string) - Proxy IPv4 TCP/IP Protocol address (not required)
   7. proxy-ip6 (string) - Proxy IPv6 TCP/IP Protocol address (not required)
   8. network-addy (string) - Netbios network name (not required)

checksfsbans

This function returns an array of based on the array provided by Stop Forum Spam with a username and password and replies with a JSON Array request. It is used for checking if some details are baned on the SFS and ensures you have a seemless entry to retieving bans on the Xortify cloud. The function is broken down into the following JSON package fielded array:

1. username (string)
2. password (string)
3. email (string) - email of the offender (not required)
4. uname (string) - username of the offender (not required)
5. ip4 (string) - IPv4 Tcp/ip protcol address (requires either ip4 or ip6)
6. ip6 (string) - IPv6 Tcp/ip protcol address (requires either ip4 or ip6

checkphpbans

This function returns an array of based on the array provided by Project Honeypotwith a username and password and replies with a JSON Array request. It is used for checking if some details are baned on the SFS and ensures you have a seemless entry to retieving bans on the Xortify cloud. The function is broken down into the following JSON package fielded array:

1. username (string)
2. password (string)
3. ip4 (string) - IPv4 Tcp/ip protcol address (requires either ip4 or ip6)

spider

This function listing a spider on the cloud with a username and password and replies with a JSON Array request. It is used for checking and maintaining the list of robots on the Xortify cloud. The function is broken down into the following JSON package fielded array and is moderated so your spider will not appear immediately. If you want to add a crawler or robot to the xortify cloud this is the function you use to list it.

1. username (string)
2. password (string)
3. spider (array)
   1. robot-id (string) - Unique ID String for Robot
   2. robot-name (string) - Robot Name
   3. robot-cover-url (string) - Coverage URL for Robot that is the URL where search is done from
   4. robot-details-url (string) - Host network address end that is used, ie. googlebot.com
   5. robot-owner-name (string) - Company/Business of Ownership
   6. robot-owner-url (string) - Owner URL
   7. robot-owner-emai (string)l - Owner eMAil
   8. robot-status (string) - Robot Status - Active/Inactive
   9. robot-purpose (string) - Robot Purpose
   10. robot-type (string) - Robot Type
   11. robot-platform (string) - Robot software platform
   12. robot-availability (string) - Robot Availability
   13. robot-exclusion (string) - Useragent Matching exclusion most unique
   14. robot-exclusion-useragent (string) - Useragent Matching exclusion most unique
   15. robot-noindex (string) - Follows No Index
   16. robot-host (string) - Follows Host
   17. robot-from (string) - country of origin
   18. robot-useragent (string) - Full Useragent
   19. robot-language (string) - Language
   20. robot-description (string) - Description
   21. robot-history (string) - History
   22. robot-environment (string) - Environment
   23. modified-date (string) - Modified date YYYY-MM-DD HH:MM:SS
   24. modified-by (string) - Your name/Company Name

spiders

This function retreieves a alisting of spiders on the cloud with a username and password and replies with a JSON Array request. It is used for checking and rerieving the list of robots on the Xortify cloud. The function is broken down into the following JSON package fielded array and is moderated so your spider will not appear immediately.

1. username (string)
2. password (string)
3. records (integer)

spiderstat

This function listing a spider statistic on the Xortify cloud with a username and password and replies with a JSON Array request inluding whether the user matched the Useragent or if it was banned for someone impersonating a Robot. It is used for adding and banning a person who is not a spider but impersonating on with the list of robots on the Xortify cloud. The function is broken down into the following JSON package fielded array and is moderated so your spider will not appear immediately.

1. username (string)
2. password (string)
3. uri (string) - URL of the page being crawled
4. useragent (string) - Useragent of the crawler
5. netaddy (string) - Netbios network address name
6. ip (string) - IP of crawler
7. server-ip (string) - IP of the server
8. when (integer) - Unix timestamp of when crawl was done (GMT10).
9. sitename (string) - Site name
10. robot-id (string) - robot-id (taken from function spiders retrieval)
11. robot-name (string) - robot-name (taken from function of spiders cache)

seolinks

This function retieeving a spider statistic on the Xortify cloud for the basis of last crawled to display at the base of your website to another robot with a username and password and replies with a JSON Array request. It is used for retrieving a crawl list from the most recent on with the list of robots on the Xortify cloud. The function is broken down into the following JSON package fielded array and is moderated so your spider will not appear immediately.

1. username (string)
2. password (string)
3. records (integer)