Getting Started with ClickaPost API (FAQs)

While the documentation contains everything you need to know, sometimes, the most basic questions lack answers.

Here are some of them (with the answers, of course):

  1. What's an API?
    • API stands for Application Programming Interface, and it allows users, applications and services to interface with ClickaPost.
  2. What can I use it for?
    • It comes in quite handy for posting in bulk to ClickaPost (if you have another classifieds site, or if you represent a Real Estate company, a Job Listing Service, etc.). It can also be used by your own application which can in turn provide a different interface, and/or platform for using ClickaPost services (ex: a Desktop application for posting to ClickaPost).
  3. Why is ClickaPost better?
    • ClickaPost is a very unique On-Line Classifieds site with a genuine set of features others can't even begin to match. From a beautiful Web 2.0 look, video uploads, high quality images, rich text support for post descriptions, to over 400 easily searchable categories for posting your listings right where they belong and full-featured and flexible API allowing you to interface with the system in ways previously unimaginable, the question one should be asking is: Why haven't I used ClickaPost to begin with? We care not only about content, but superb user experience as well. Besides the mentioned features, which other site allows users to comment on posts, contact posters directly, ask questions about posts via our integrated forum, and offers all of this for free?
  4. Sounds good, what do I need to get started?
    • You need to register for a free ClickaPost account. Once you activate it, in My ClickaPost module you will find a section called ClickaPost API. From there you may generate your authentication token (needed for accessing the XML-RPC server), and set other important options.
  5. Are there any rules that should be followed?
  6. Do you accept any kind of XML/RSS feed, or does it have to be specific?
    • Like most API's, the instructions that can be interpreted by our server are specific. More info on ClickaPost XML syntax may be found on our XML Post Requests section of this site.
  7. Where do I send the XML files in order to post on ClickaPost
    • We have TWO XML-RPC servers which can interpret your XML feeds.
    1. http://api.clickapost.com/server.php is a LIVE server, meaning, all XML feeds submitted to this server will be parsed and published LIVE on ClickaPost.com!
    2. http://api.clickapost.com/testing_server.php is a TESTING server which works exactly the same (parsing your XML feed and returning a proper response), however, the testing server will NOT publish your posts on ClickaPost.com, thus allowing you to send same feed as many times as you like during the development period, without spamming the system.
  8. ClickaPost XML format requires some specific Category ID's, keywords and such, where do I get them?
    • Some XML fields are easy to understand and populate (such as Country tag), however, others are specific to our system and you may need these values first. All of them are easily acquired using our XML Get Methods, or, to make it even simpler, from ClickaPost Categories page.
  9. Is there a way for ClickaPost to simply get my XML file automatically without me sending it?
    • Well, of course! We thought about this as well. If you don't have the know-how on how to program and access the API directly, or if you simply do not wish to bother with it, ClickaPost allows you to set a URL of your XML feed right on our site. This URL will be automatically visited every night, your posts downloaded and posted under your account. All you need is a valid XML file ClickaPost understands. More about this in Automatic XML Processing section.
  10. Is there a way to UPDATE posts already published via XML, or do all of them get posted as new?
    • In the Optional Fields section, you will find explanation about <customId> tag. It is strongly recommended that all of your posts have this tag present. All posts submitted without the <customId> tag will be submitted as New Posts (without a chance for you to ever modify them via API again, only manually), however, if you submit posts with the <customId> tag, the system will automatically UPDATE the existing post with the new data sent, and not create a brand new post. For more info, check out Updating Posts via API.
  11. I'm stuck, where/how do I get help?
    • Not a biggie, simply drop us a line at api@clickapost.com and we'll help you out right away!

The following topics should get you started

  1. XML Post Requests - learn how posts can be submitted to ClickaPost via XML and about the XML feed we accept
  2. Automatic XML Processing - learn how you can instruct ClickaPost to process your XML files automatically
  3. 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
  4. Download the latest version of PDF Documentation

For more info, examples, etc., please go back to the front page.

 
getting_started.txt · Last modified: 2008/12/15 21:13 by peconi
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki