Cronblocks API Documentation – Introduction

Getting your API Key

To begin using Cronblocks.com’s API, you need to first get your API key. API keys are unique to each user and can be found under the Profile section of the Admin Interface.

Input/Output Formats

Cronblocks.com uses REST to communicate with third parties. Methods which present data will only accept GET requests, while methods which change data require POST requests. Check the individual method documentation to see which one to use.

Output format can be specified by the caller through the data_type input parameter. Accepted values are: JSON (default) and XML. Case insensitive. The output format will vary according to SUCCESSful or ERRORed results.

For ERROR replies, a typical JSON output will be as follows:

{"status":"ERROR","msg":"Some Error Message"}

Its XML counterpart will be:

<?xml version="1.0"?>
<api_name>
    <status>ERROR</status>
    <msg>Some Error Message</msg>
</api_name>

For SUCCESS replies, there will be a status section and a data section. The data section will vary according to the API called. A typical Sign Up call would yield:

{"api_name":"sign_up","status":"SUCCESS","data":{"user_id":1}}

or

<?xml version="1.0"?>
<sign_up>
    <status>SUCCESS</status>
    <data>
        <api_key>abcdefghi123435</api_key>
    </data>
</sign_up>

See available methods in the sidebar menu.

This entry was posted in API Documentation and tagged permalink. Trackbacks are closed, but you can post a comment.

Post a Comment

Your email is never published nor shared.

You may use these HTML tags and attributes <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

*