Difference between revisions of "SailBlogs API"

From SailBlogs Support Wiki
Jump to: navigation, search
Line 1: Line 1:
The SailBlogs API provides a way for advanced user and developers to integrate SailBlogs information into external websites running PHP. This is handled by calling various programs on the SailBlogs server which returns an XML response.  
+
The SailBlogs API provides a way for advanced users and developers to integrate SailBlogs information into external websites running PHP. This is handled by calling various programs on the SailBlogs server which returns an XML response.  
  
 
== Requirements ==
 
== Requirements ==
Line 10: Line 10:
 
=== PHP 5.0 or Greater ===
 
=== PHP 5.0 or Greater ===
 
The SailBlogs-developed API Class, which automates much of the API calls to the server, requires PHP 5 or greater.  
 
The SailBlogs-developed API Class, which automates much of the API calls to the server, requires PHP 5 or greater.  
 
+
* XML support must be complied into PHP to use the API Class. See http://us.php.net/manual/en/book.xml.php
=== XML Support ===
+
* fopen wrappers must be enabled. See http://us.php.net/manual/en/wrappers.php
XML support must be complied into PHP to use the API Class.
 
  
 
==Support==
 
==Support==
Line 19: Line 18:
 
==Class Reference==
 
==Class Reference==
 
=== Properties ===
 
=== Properties ===
 +
*blogDirName
 +
*blogID
 +
*cache
 +
*cacheLoc
 +
*cacheFile
 +
*cacheTime
  
 
=== Functions ===
 
=== Functions ===
 
The following functions are available in the API Class.
 
The following functions are available in the API Class.
*[[SailBlogs API: xj_api|xj_api]]
 
 
*[[SailBlogs API: getXJEntries|getXJEntries]]
 
*[[SailBlogs API: getXJEntries|getXJEntries]]
 
*[[SailBlogs API: getXJComments|getXJComments]]
 
*[[SailBlogs API: getXJComments|getXJComments]]
 
*[[SailBlogs API: getContents|getContents]]
 
*[[SailBlogs API: getContents|getContents]]

Revision as of 16:46, 16 August 2008

The SailBlogs API provides a way for advanced users and developers to integrate SailBlogs information into external websites running PHP. This is handled by calling various programs on the SailBlogs server which returns an XML response.

Requirements

API Key

To use the API a developer must request an API key. Contact SailBlogs to request a key.

Premium Account

Only SailBlogs Premium Memberships can be accessed via the API.

PHP 5.0 or Greater

The SailBlogs-developed API Class, which automates much of the API calls to the server, requires PHP 5 or greater.

Support

Limited support is available for the API, and only via email.

Class Reference

Properties

  • blogDirName
  • blogID
  • cache
  • cacheLoc
  • cacheFile
  • cacheTime

Functions

The following functions are available in the API Class.