Fall Kickoff: the LightCMS blogging API
That's right, the blogging API is here. As mentioned in the video, more details and tutorials will follow, but in case you want to check it out right away, here's a little bit of info to get your started.
- Many application clients will be able to auto-discover the API settings. You will just need to point them to the URL containing the blog element you want to edit. For example, to target the LightCMS blog, we would enter http://www.speaklight.com/blog
- If the client requires manual configuration, the URL for the API service itself is https://[your publishpath url]/metaweblog.ashx — PLEASE NOTE: our API requires a secure connection so you must use https and you must use your publishpath address when configuring manually.
- Remember that, as with any API integration, the quality of the user experience will be dependent on how well the client application works. We can support the API itself, but we can't guarantee or support the applications you may use to access the API.
- If you have multiple blog instances on your website, the API will return all of those instances to the client. We have noted that some clients do not support multiple instances so they will typically grab the first returned blog instance, which often will be the one you want (because it is typically the first blog element you added to the site). Many client applications do support multiple instances and will give you the choice of which one to use or the ability to switch between them. Tip: having good descriptive titles on your elements will make them easier to distinguish in some clients.
- We'll be adding more posts in the future about specific applications with ideas on how to use them. For now, we will just mention a few options. Windows Live Writer works well and if free, but only available for PC. ScribeFire is a free Firefox plugin that works on both PC and Mac and does a pretty good job. On the iPhone, you can try out BlogWriter Lite, which is free, but will only support a single blog instance. There is also iBlogger for iPhone that works better, but is a $10 app. More to come on these.
- Just so you know, our team has kept security at the top of the agenda when implementing the API. All API calls are required to occur over secure connections. Plus, if you want an additional layer of security, you can consider creating a specific user account just for the API login that only has access to the elements you wish to edit. This is not necessary as all API calls are secure, but it can offer you an additional layer of security if you wish to use it.
API integration is often requested, and we're pleased to bring you this feature. We'd love to hear what you think and how you are using it. If you find applications that work particularly well for your purposes, please let us all know.
Posted on Fri, November 20, 2009
by Tim Wall filed under