API Overview

The PostNuke API is a set of functions for the PostNuke content system that allows developers to access key information and manage their specific content in an easy fashion.

Advantages of an API

There are a number of advantages to having an API for the PostNuke system. Primarily, using an API allows developers to write PostNuke-compliant code that they can guarantee will still work whenever PostNuke is upgraded. This is especially important for a system such as PostNuke as the core functionality of the system is at current very much in flux and is altering rapidly to meet the demands being placed upon it. Having a stable interface into the system is one way of ensuring that the core developers can continue their work on updating and optimising the PostNuke system without continually breaking the code that module developers have written.

Other reasons for using an API include the ability for developers to start working with PostNuke more quickly without needing to understand the internals of the system, and to have standardised ways of obtaining and manipulating information.

Disadvantages of an API

The main disadvantage of having an API is when you want to do something that it does not have a suitable function for. This problem is addressed by encouraging developers to submit their own suggestions for new API functions, and even the functions themselves, for introduction into the core (details on the procedures for doing this are below).

An API also adds overhead to the entire system, but the trade-off in stability and ease of development more than compensates for this.

Who should use this API?

The PostNuke API is primarily aimed at developers who wish to write modules for the PostNuke system. In addition, some theme designers might use these functions to provide advanced features within their theme.