Search

RSS / Atom

Textpattern Links

Textpattern XML-RPC API

# 11 04 2005 - 17:09 #

This document describes the XML-RPC programmatic interfaces implemented by Textpattern XML-RPC server1.

Textpattern provides support for the most extended XML-RPC blog APIs. This means:

TXP_RPCServer is built on top of Simon Willison’s XML-RPC IXR Library, providing an Introspection server, which is able to answer clients about the public methods it implements.

You can get a list of all the system supported methods programmatically using either the RPC methods system.listMethods and mt.supportedMethods . The XML-RPC server implementation is also able to retrieve a list of supported capabilities using the method system.getCapabilities .

The Blogger API

Textpattern XML-RPC server supports the whole Blogger XML-RPC API with some assumptions:

General information about Textpattern implementation of Blogger API XML-RPC

Blogger API supported methods:

Metaweblog API

The method metaWeblog.newMediaObject isn’t supported – and it will be not in the future, due to the vastly mayory of XML-RPC clients are able to upload files using built in FTP clients.

General information about Textpattern implementation of MetaWeblog API XML-RPC

Metaweblog API supported methods

MovableType API

TXP-RPC server implements some methods of the MovableType API.

The method mt.getTrackbackPings is not supported, since Textpattern doesn’t implements TrackBack. mt.publishPost is supported only to silence some clients errors, since it has sense for software which requires file rebuilds, but not for a dyamic one, like textpattern.

General information about Textpattern implementation of Movable Type API XML-RPC

MovableType API supported methods

1 TXP_Wrapper

All these interfaces access Textpattern DataBase through a wrapper class called TXP_Wrapper, which takes care about things like user validation, privileges and data process before to add it to the Textpattern DB.

Main goal of this class is to keep API implementations focused on the task they undertake, without worry about how data should be formated before to be inserted or retrieved from the Textpattern DB, in function of User Preferences.

We strongly recommend to all Textpattern API developers to use this class with their applications.

The class is not only intended to be used with XML related APIs, but from any application which has access with Textpattern Data, like a moblogging client and so on.

Detailed class information

Comment