ρ (rho) wrote in lj_userdoc,
ρ
rho
lj_userdoc

  • Music:

[clients] Proposed new FAQ (blogger/atom APIs)

I'd like to propose the addition of a new FAQ for the clients category, about use of the Blogger and Atom client APIs. I've written up a draft, but would very much appreciate any constructive criticism on it as I think it's far from perfect.

Can I update my LiveJournal with a client from another site?

In general, clients that are specifically written for LiveJournal are most likely to work with the site. Such clients are available for a wide variety of different platforms. However, if your platform is not supported or if you wish to use a particular client, then you may be able to.

In addition to the LiveJournal client protocol, LiveJournal also offers partial support for the Blogger API and the Atom API. Support for both of these protocols is provided "as is" and should be considered to be in beta testing. Many features available in clients developed for LiveJournal may be unavailable when using other clients. LiveJournal cannot offer assistance with the use of these protocols, nor with clients that use them. If you don't know whether your client supports these protocols, you should refer to the client's documentation, or contact its developer.

To use the Atom API, you should use the following URL:

http://www.livejournal.com/interface/atomapi/exampleusername/post

"exampleusername" can be replaced either with your own username, or with the username of a community you wish to post to, provided you have posting access there.

To use the blogger API, you must enter the following as the interface URL in your client:

http://www.livejournal.com/interface/blogger/

If you wish to include a subject line on your entries posted using the blogger interface, you can do so by including it on the first line of your entry's body, surrounded by <title> tags. For example:

<title>This is the subject of my entry</title>

You can include current mood and current music by including the lines like the following within the body of your entry:

lj-mood: happy
lj-music: John Lennon - Imagine


FURTHER READING

What is a downloadable client? Where can I get one?
http://www.livejournal.com/support/faqbrowse.bml?faqid=158

Technical information about the blogger API
http://www.livejournal.com/doc/server/ljp.csp.blogger.html

How do I add my current mood and current music to my journal entries?
http://www.livejournal.com/support/faqbrowse.bml?faqid=32

How do I post in a community?
http://www.livejournal.com/support/faqbrowse.bml?faqid=76




I've tested the blogger API bits of this, but couldn't test the Atom bits because I couldn't find a single client that supports the Atom API. If anyone reading this actually knows how that works and could offer clarification or more information, or just confirmation, then that would be good. The information I have on it comes from an entry from lj_clients.

As far as I know, I've just plucked the thing about these two APIs being provided "as is" and being "in beta" out of thin air, but they both seem reasonable, given that neither of the APIs themselves should really be considered anything more than that (at most). If there's any objections to that from employees, then speak now.

I've tended to use somewhat more complex language in this FAQ than I generally would do, as it's somewhat difficult to explain this sort of concept without veering slightly into the complex, and the sort of people who will need this FAQ are probably OK with it.

To whichever docadmin adds this, I think that it should be given sortorder of 30 (ie, after all of the other FAQs in the category).

Edit: Have updated and corrected the further reading section based on comments from janinedog and phoenixdreaming. I've also changed "guarantedd to work" to "most likely to work".
Subscribe
  • Post a new comment

    Error

    Comments allowed for members only

    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded 

  • 5 comments