API : API
New Members
sarvirus
sarvirus
2014/7/29
testttt
testttt
2014/7/26
churchhall
churchhall
2014/7/18
Chino
Chino
2014/7/10
SBlackmon
SBlackmon
2014/6/25
B50X
B50X
2014/6/12
CDuFaur
CDuFaur
2014/5/23
MDyke
MDyke
2014/5/20
DHeagney
DHeagney
2014/5/14
WMahon
WMahon
2014/5/13
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 2011/3/24    
Login




Remember me

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

Members: 1
Guests: 9

Wolcano,