[[http://clickapost.com/|{{ http://clickapost.com/images/clickapostLogoWhiteEmail.png}}]]===== Welcome to ClickaPost API Info Wiki =====

This part of our site is dedicated to the ClickaPost API (Application Programming Interface) and here you will be able to find out everything you need to know in order to successfully interface your site, script or an application with ClickaPost.com.

Our API enables users, applications, and services to POST data in bulk, as well as to access important information (list of all countries, list of states and cities, list of categories, etc.), via easy to use interface. We based our API on XML-RPC standard and have made it very flexible and easy to use.

==== IMPORTANT ====
**It is of EXTREME importance to use our TESTING SERVER FOR ALL of your testing purposes.**
  * Read this before anything else: **[[Rule Number One| Rule #1 (and the Only One)]]**
**THANK YOU!**

==== Here are the sections this documentation is divided into ====
  - [[getting_started|Getting Started]] - Frequently Asked Questions (FAQ) and some directions
  - [[XML Post Requests]] - learn how posts can be submitted to ClickaPost via XML and about the XML feed we accept
    * [[Full XML Request]] - check out how a complete XML request with all required and optional feeds looks like
    * [[Required Fields]] - the minimum requirements for a valid XML feed
    * [[Optional Fields]] - optional XML feed fields and allowed values
    * [[The STRICT Tag]] - learn about the <strict> tag and how it affects XML processing
    * [[XML Response]] - see how to interpret XML responses returned after your XML has been parsed
    * [[What happens after XML is processed]] - get familiar with internal workings of ClickaPost
    * [[Updating Posts via API]] - not every post has to be a new post, here's how to update them instead
  - [[Automatic XML Processing]] - learn how you can instruct ClickaPost to process your XML files automatically
  - [[XML Get Methods]] - learn about all different methods for getting specific data required for your posts (like States, Cities, Keywords, etc.)
    * [[XML Get Example]] - a simple XML Get method example for getting the list of countries on ClickaPost
    * [[Available XML Get Methods]] - a list of all Get methods you may use, with explanation on what they give in return
  - [[ClickaPost Categories]] - a list of all available categories and their unique ID's
  - Download the latest version of [[PDF Documentation]]

==== Useful tools ====
Once you get familiar with how ClickaPost API works from the documentation, you will find the following tools quite useful during testing:
  * [[XML Parser Demo]] - here you may either copy/paste your XML code or provide the parser with the URL to your XML feed in order to test if it is formed correctly and to see if it is ready for the prime time
  * [[XML Get Methods Demo]] - get familiar with how the XML Get methods work and with the data they return

==== Examples ====
Sample scripts to get you started right off the bat.
  * [[POST/GET Request Examples]] - submitting your XML data via HTTP's POST and GET
  * [[CURL Request Example]] - here's how to submit an XML file using curl (a command line tool for transferring files with URL syntax)
  * [[PHP Client Script Example]] - a PHP script to get you started with sending your posts to ClickaPost using PHP and XML
  * [[PHP Get Methods Script Example]] - a PHP script to get you started with getting important data from ClickaPost in XML format and parsing it through via PHP