API : API
API

 

API Documentation

What is an API?

An API is a programmable interface which allows for users to interact with a system via various protocols. These protocols include Open Access Protocol (wGET), cURL and SOAP on this system and have a range of functions to support the environment. Below is a list of functions which are available for use to proclimate a ban or find out information on a spider/crawler or robot.

The API here at Xortify are farely straight forward and provide there responses in arrays either through XML with SOAP or a JSON response with wGET or cURL. You just need to use the port you want to for the process. Please see wikipedia for a full definition of an API which stands for Application Programmable Interface.

Ports for API

wGET

wGET or Open Access protocol is commonly refered to as functions for example in php like file_get_contents() this is a function which does a direct read off a URL for a response, the response in this port is in a JSON encoded string and the functions calling to it are also encoded in JSON. Depending on whether you are using a long query is whether you POST or GET the function call, but it really doesn't matter the API will respond to you anyway. The port/url you use to talk to this api is http://xortify.chronolabs.coop/json/ which will provided easy access to the functions on the wGET/CURL JSON API functions.

cURL

cURL protocol is commonly refered to as functions for example in php like curl library this is a function which does a direct read off a URL for a response with curl, the response in this port is in a JSON encoded string and the functions calling to it are also encoded in JSON. Depending on whether you are using a long query is whether you POST or GET the function call, but it really doesn't matter the API will respond to you anyway. The port/url you use to talk to this api is http://xortify.chronolabs.coop/curl/ which will provided easy access to the functions on the wGET/CURL JSON API functions.

SOAP

SOAP protocol is commonly refered to as simple object access protocol - this is a function which does a direct read off a URL for a response with soap protocol which is a conversation in XML, the response in this port is in a Array XML encoded and the functions calling to it are not encoded in JSON unlike the other to API. Depending on whether you are using a long query is whether you POST or GET the function call, but it really doesn't matter the API will respond to you anyway. The port/url you use to talk to this api is http://xortify.chronolabs.coop/soap/ which will provided easy access to the functions on the SOAP API functions.


Written by: System Overlord 03/24/2011    
Login




Remember me

Lost Password?
Register now!
Who's Online
19 user(s) are online (16 user(s) are browsing Content Module)

Members: 1
Guests: 18

labscoop, more...
Errors
Notice: File Path Error: var/configs/xoopsconfig.php does not exist. in file /include/common.php line 130
Deprecated
xoops_load('cache') is deprecated, use xoops_load('xoopscache')
Queries
0.000069 - SET NAMES 'utf8'
0.000043 - SET SQL_BIG_SELECTS = 1
0.000058 - SELECT * FROM config WHERE (conf_modid = '0' AND conf_catid = '1') ORDER BY conf_order ASC
0.000208 - SELECT sess_data, sess_ip FROM session WHERE sess_id = 'md8lflck2jqiu3v4uokvv66c24'
0.000046 - SELECT * FROM modules WHERE dirname = 'xcenter'
0.000044 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '1' AND (gperm_groupid = '3') AND gperm_name = 'module_read' AND gperm_itemid = '11')
0.000053 - SELECT * FROM config WHERE (conf_modid = '11') ORDER BY conf_order ASC
0.000046 - SELECT * FROM modules WHERE dirname = 'xrest'
0.000047 - SELECT * FROM config WHERE (conf_modid = '22' AND conf_catid = '0') ORDER BY conf_order ASC
0.000107 - DELETE FROM protector_access WHERE expire < UNIX_TIMESTAMP()
0.000172 - SELECT COUNT(*) FROM protector_access WHERE ip='54.205.168.88' AND request_uri='/document/api/api-documentation/2,2.html'
0.000057 - SELECT COUNT(*) FROM `noticer_email` WHERE (sent = '0')
0.000061 - SELECT COUNT(*) FROM modules WHERE (dirname = 'xlanguage' AND isactive = '1')
0.000047 - SELECT COUNT(*) FROM banner
0.000046 - SELECT * FROM config WHERE (conf_modid = '0' AND conf_catid = '3') ORDER BY conf_order ASC
0.000048 - SELECT DISTINCT gperm_itemid FROM group_permission WHERE gperm_name = 'block_read' AND gperm_modid = 1 AND gperm_groupid IN (3)
0.000049 - SELECT b.* FROM newblocks b, block_module_link m WHERE m.block_id=b.bid AND b.isactive=1 AND b.visible=1 AND m.module_id IN (0,11) AND b.bid IN (23,22,18,17,16,15,14,13,40,39,38,37,12,11,10,9,8,7,6,5,4,3,2,1,30) ORDER BY b.weight, m.block_id
0.000051 - SELECT f.*, s.tpl_source FROM tplfile f LEFT JOIN tplsource s ON s.tpl_id=f.tpl_id WHERE (tpl_tplset = 'default' AND tpl_file = 'system_block_login.html') ORDER BY tpl_refid
0.000092 - SELECT f.*, s.tpl_source FROM tplfile f LEFT JOIN tplsource s ON s.tpl_id=f.tpl_id WHERE (tpl_tplset = 'default' AND tpl_file = 'system_block_dummy.html') ORDER BY tpl_refid
0.000053 - SELECT * FROM config WHERE (conf_modid = '11' AND conf_catid = '0') ORDER BY conf_order ASC
0.000327 - SELECT * FROM `xcenter_xcenter` WHERE (parent_id = '0' AND submenu = '1' AND visible = '1' AND (publish < '1412092156' OR publish = '0') AND (expire > '1412092156' OR expire = '0')) ORDER BY weight ASC
0.000045 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '1')
0.000068 - SELECT * FROM `xcenter_text` WHERE (storyid = '1' AND language = 'english' AND type = 'xcenter')
0.000056 - SELECT * FROM `xcenter_xcenter` WHERE (parent_id = '1' AND submenu = '1')
0.000048 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '2')
0.000050 - SELECT * FROM `xcenter_text` WHERE (storyid = '2' AND language = 'english' AND type = 'xcenter')
0.000074 - SELECT * FROM `xcenter_xcenter` WHERE (parent_id = '2' AND submenu = '1')
0.000060 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '2')
0.000100 - SELECT * FROM `xcenter_text` WHERE (storyid = '3' AND language = 'english' AND type = 'xcenter')
0.000044 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '2')
0.000063 - SELECT * FROM `xcenter_text` WHERE (storyid = '4' AND language = 'english' AND type = 'xcenter')
0.000043 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '2')
0.000063 - SELECT * FROM `xcenter_text` WHERE (storyid = '8' AND language = 'english' AND type = 'xcenter')
0.000043 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '2')
0.000061 - SELECT * FROM `xcenter_text` WHERE (storyid = '9' AND language = 'english' AND type = 'xcenter')
0.000044 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '2')
0.000055 - SELECT * FROM `xcenter_text` WHERE (storyid = '13' AND language = 'english' AND type = 'xcenter')
0.000043 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '12')
0.000044 - SELECT * FROM `xcenter_text` WHERE (storyid = '12' AND language = 'english' AND type = 'xcenter')
0.000051 - SELECT * FROM `xcenter_xcenter` WHERE (parent_id = '12' AND submenu = '1')
0.000045 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '12')
0.000056 - SELECT * FROM `xcenter_text` WHERE (storyid = '5' AND language = 'english' AND type = 'xcenter')
0.000043 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '12')
0.000057 - SELECT * FROM `xcenter_text` WHERE (storyid = '6' AND language = 'english' AND type = 'xcenter')
0.000052 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '12')
0.000055 - SELECT * FROM `xcenter_text` WHERE (storyid = '7' AND language = 'english' AND type = 'xcenter')
0.000052 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '12')
0.000056 - SELECT * FROM `xcenter_text` WHERE (storyid = '10' AND language = 'english' AND type = 'xcenter')
0.000043 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '12')
0.000074 - SELECT * FROM `xcenter_text` WHERE (storyid = '11' AND language = 'english' AND type = 'xcenter')
0.000050 - SELECT f.*, s.tpl_source FROM tplfile f LEFT JOIN tplsource s ON s.tpl_id=f.tpl_id WHERE (tpl_tplset = 'default' AND tpl_file = 'xcenter_block_menu.html') ORDER BY tpl_refid
0.000050 - SELECT * FROM modules WHERE (hasmain = '1' AND isactive = '1' AND weight > '0') ORDER BY weight ASC, mid ASC
0.000046 - SELECT * FROM group_permission WHERE (gperm_name = 'module_read' AND gperm_modid = '1' AND gperm_groupid = '3')
0.000063 - SELECT * FROM `profile_field`
0.000059 - SELECT f.*, s.tpl_source FROM tplfile f LEFT JOIN tplsource s ON s.tpl_id=f.tpl_id WHERE (tpl_tplset = 'default' AND tpl_file = 'system_block_mainmenu.html') ORDER BY tpl_refid
0.000063 - SELECT * FROM `users` WHERE (level > '0') ORDER BY user_regdate DESC LIMIT 0, 10
0.000056 - SELECT f.*, s.tpl_source FROM tplfile f LEFT JOIN tplsource s ON s.tpl_id=f.tpl_id WHERE (tpl_tplset = 'default' AND tpl_file = 'system_block_newusers.html') ORDER BY tpl_refid
0.000254 - SELECT COUNT(*) FROM online WHERE online_uid=0 AND online_ip='54.205.168.88'
0.000145 - INSERT INTO online (online_uid, online_uname, online_updated, online_ip, online_module) VALUES (0, '', 1412092156, '54.205.168.88', 11)
0.000136 - SELECT * FROM online
0.000133 - SELECT COUNT(*) FROM online WHERE online_module = '11'
0.000050 - SELECT f.*, s.tpl_source FROM tplfile f LEFT JOIN tplsource s ON s.tpl_id=f.tpl_id WHERE (tpl_tplset = 'default' AND tpl_file = 'system_block_online.html') ORDER BY tpl_refid
0.000047 - SELECT COUNT(*) FROM `xcenter_xcenter` WHERE storyid = '2'
0.000050 - SELECT * FROM `xcenter_text` WHERE (storyid = '2' AND language = 'english' AND type = 'xcenter')
0.000050 - SELECT * FROM xcenter_xcenter WHERE storyid = '2'
0.000045 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'all_default' AND gperm_itemid = '4')
0.000042 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'all_default' AND gperm_itemid = '10')
0.000081 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '2')
0.000042 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_category' AND gperm_itemid = '2')
0.000050 - SELECT * FROM users WHERE uid = '1'
0.000048 - SELECT * FROM smiles
0.000063 - SELECT * FROM xcenter_xcenter WHERE storyid = '2'
0.000052 - SELECT * FROM `xcenter_text` WHERE (storyid = '2' AND language = 'english' AND type = 'xcenter')
0.000050 - SELECT * FROM `xcenter_text` WHERE (storyid = '2' AND language = 'english' AND type = 'xcenter')
0.000051 - SELECT * FROM xcenter_xcenter WHERE storyid = '2'
0.000050 - SELECT * FROM `xcenter_text` WHERE (storyid = '2' AND language = 'english' AND type = 'xcenter')
0.000048 - SELECT * FROM `xcenter_text` WHERE (catid = '2' AND type = 'category' AND language = 'english')
0.000061 - SELECT * FROM xcenter_xcenter WHERE storyid = '2'
0.000050 - SELECT * FROM `xcenter_text` WHERE (storyid = '2' AND language = 'english' AND type = 'xcenter')
0.000046 - SELECT * FROM `xcenter_text` WHERE (catid = '2' AND type = 'category' AND language = 'english')
0.000055 - SELECT * FROM xcenter_xcenter WHERE storyid = '2'
0.000049 - SELECT * FROM `xcenter_text` WHERE (storyid = '2' AND language = 'english' AND type = 'xcenter')
0.000046 - SELECT * FROM `xcenter_text` WHERE (catid = '2' AND type = 'category' AND language = 'english')
0.000053 - SELECT * FROM modules WHERE dirname = 'tag'
0.000046 - SELECT * FROM config WHERE (conf_modid = '18') ORDER BY conf_order ASC
0.000052 - SELECT o.tag_id, o.tag_term FROM tag_link AS l LEFT JOIN tag_tag AS o ON o.tag_id = l.tag_id WHERE l.tag_itemid = 2 AND l.tag_modid = 11 ORDER BY o.tag_count DESC
0.000045 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '1' AND (gperm_groupid = '3') AND gperm_name = 'system_admin' AND gperm_itemid = '14')
0.000224 - SELECT * FROM `xcenter_xcenter` WHERE (submenu = '1' AND parent_id = '0' AND visible = '1' AND (publish < '1412092156' OR publish = '0') AND (expire > '1412092156' OR expire = '0'))
0.000054 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'all_default' AND gperm_itemid = '1')
0.000039 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'all_default' AND gperm_itemid = '2')
0.000039 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'all_default' AND gperm_itemid = '3')
0.000039 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'all_default' AND gperm_itemid = '17')
0.000080 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'all_default' AND gperm_itemid = '18')
0.000042 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'all_default' AND gperm_itemid = '19')
0.000039 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'all_default' AND gperm_itemid = '16')
0.000040 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '1')
0.000039 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_category' AND gperm_itemid = '1')
0.000039 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '2')
0.000042 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_category' AND gperm_itemid = '2')
0.000072 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_xcenter' AND gperm_itemid = '12')
0.000040 - SELECT COUNT(*) FROM group_permission WHERE (gperm_modid = '11' AND (gperm_groupid = '3') AND gperm_name = 'view_category' AND gperm_itemid = '2')
0.000053 - SELECT * FROM xoopscomments WHERE (com_modid = '11' AND com_itemid = '2' AND com_pid = '0') ORDER BY com_id ASC
0.000063 - SELECT f.*, s.tpl_source FROM tplfile f LEFT JOIN tplsource s ON s.tpl_id=f.tpl_id WHERE (tpl_tplset = 'default' AND tpl_file = 'xcenter_index.html') ORDER BY tpl_refid
0.000050 - SELECT f.*, s.tpl_source FROM tplfile f LEFT JOIN tplsource s ON s.tpl_id=f.tpl_id WHERE (tpl_tplset = 'default' AND tpl_file = 'xcenter_breadcrumb.html') ORDER BY tpl_refid
0.000085 - SELECT * FROM modules WHERE dirname = 'profile'
0.000063 - SELECT * FROM config WHERE (conf_modid = '9' AND conf_catid = '0') ORDER BY conf_order ASC
Total: 106
Blocks
Login: Not cached
Custom Block (PHP): Not cached
User Menu: Not cached
Menu for Xcenter: Not cached
Main Menu: Not cached
New Members: Not cached
Who is Online: Not cached
Total: 7
Extra
Included files: 188 files
Memory usage: 2832856 bytes
Timers
XOOPS took 0.441 seconds to load.
XOOPS Boot took 0.004 seconds to load.
Module init took 0.004 seconds to load.
XOOPS output init took 0.017 seconds to load.
Module display took 0.011 seconds to load.
Page rendering took 0.404 seconds to load.