Get Started with the Deploy^* API

This is only a sample as the API has yet to be released!

Sample API Call

http://projecydeploy.org/api/?css=resets|css&css=blank|css&js_lib=jquery|1.3.2&js=jquery|js&html=html4_strict|_root_|index.php&dir=designs

Explanation

This is the base URL that you need to use the API: http://projecydeploy.org/api/

Everything after that is a set of Deploy* functions and parameters. In the above example we use the following functions:

• css
• js_lib
• js
• html
• dir

These are only a few of the many Deploy* API functions. Let's brake down the html function we used above.

Each function has at least one parameter. The html function has 4 parameters. They are, respectively:

1. HTML Type (str)[xhtml1_transitional]
   1. html4_strict
   2. html4_transitional
   3. xhtml1_strict
   4. xhtml1_transitional
   5. xhtml1_1
   6. html5
2. Location (str)[_root_]
3. File Name (str)[index.html]
4. Title (str)[Title]

The example URL uses the first three parameters by separating each parameter with a pipe (|). Each function starts with a & (except for the very first function called which starts with a ?. Notice the example above). To leave a parameter blank, add the pipe, but just leave it blank. For example, above could also be written like (but wasn't for example's sake): &html=html4_strict||index.php

Here is an example XML request: sample.xml

Next read up on the functions and their parameters.