SyCara API

This API was developed to give easy external access to the Site Cara functionality. The API is based on REST with GET being used for stateless queries and PUT being used to change state.

Documentation

Each call will return a XML structure bounded by <result systemerrors='x'></result>. If systemerrors is set to 1 or more then an issue with parameters passed to the API was detected, in which case <error>text</error> will be returned with more information on the errors detected.

Robots.txt Validator

URL: http://www.sycara.com/api/robotstxt
Arguments:

key : API Key
URL : Site URL to check.

Returns: result :
Attributes:
systemerrors : number of system errors.
Children:
error : system error text.
url : robots.txt URL.
sitemap : URL of sitemaps as read from robots.txt file
message :
Children:
code : message code (note 1)
text : text of error
Example Request: http://www.sycara.com/api/robotstxt?key=test&URL=http://www.sycara.com
Example Response: 
<result systemerrors="0">
    <url>http://www.sycara.com/robots.txt</url>
    <message>
        <code>1265</code>
        <priority>75</priority>
        <prioritytext>Normal Importance</prioritytext>
        <text>Robots.txt - No XML sitemaps defined</text>
    </message>
</result>
Note 1:Code value can be passed to http://www.sycara.com/api/messagecode?code=xxxx for more information.

Page Level Validator

URL: http://www.sycara.com/api/pagecheck
Arguments:key : API Key
URL : Site URL to check.
Returns: result :
Attributes:
systemerrors : number of system errors.
Children:
error : system error text.
url : URL passed in.
message :
Children:
code : message code (note 1)
text : text of error
Example Request: http://www.sycara.com/api/pagecheck?key=test&URL=http://www.sycara.com
Example Response: 
<result systemerrors="0">
    <url>www.sycara.com</url>
    <message>
       <code>1620</code>
       <priority>125</priority>
       <prioritytext>High Importance</prioritytext>
       <text>Percentage of javascript compared to total page too high, over 40% - total length 19.18 KB.</text>
    </message>
</result>
Note 1:Code value can be passed to http://www.sycara.com/api/messagecode?code=xxxx for more information.

Optimize Page

URL: http://www.sycara.com/api/optimizepage
Arguments:key : API Key
URL : Site URL to check.
phrase : search phrase to optimize for.
Returns: result :
Attributes:
systemerrors : number of system errors.
Children:
error : system error text.
url : URL passed in.
message :
Children:
text : text of error
Example Request: http://www.sycara.com/api/optimizepage?key=test&URL=http://www.sycara.com&phrase=seo monitoring tool
Example Response: 
<result systemerrors="0">
    <url>www.sycara.com</url>
    <messages>
        <message>
           <text>Put the phrase in the title tag of the page once - currently it appears 0 times.</text>
        </message>
        <message>
           <text>Put the phrase in the meta description tag of the page between 1 and 3 times - currently it appears 0 times.</text>
        </message>
    </messages>
</result>
Loading...