Difference between revisions of "SailBlogs API"

From SailBlogs Support Wiki
Jump to: navigation, search
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
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.  
+
The SailBlogs API (application prgram interface) provides a way for advanced users and developers to integrate SailBlogs information into external websites or applications. This is handled by calling the API via http on the SailBlogs server which returns an XML response.  
  
 
== Requirements ==
 
== Requirements ==
Line 11: Line 11:
 
Limited support is available for the API, and only via email.
 
Limited support is available for the API, and only via email.
  
==HTTP Requests, XML Responses==
+
==Usage: HTTP Requests, XML Responses==
The following section describes the HTTP requests that can be made to the SailBlogs server, and the XML response that is returned.
+
See [[API Usage Guide]]
  
==Base URL==
+
==PHP Class Reference==
All calls to the SailBlogs API will be made to the following URL:
 
 
 
 
 
=== 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 must be complied into PHP to use the API Class. See http://us.php.net/manual/en/book.xml.php
* fopen wrappers must be enabled. See http://us.php.net/manual/en/wrappers.php
+
* fopen wrappers must be enabled. See http://us.php.net/manual/en/wrappers.php  
  
==PHP Class Reference==
+
The Class includes the following properties and functions:
A PHP class (PHP 5 or greater) is available that simplifies some of the API interactions for developers. The Class includes the following properties and functions:
 
  
 
=== Properties ===
 
=== Properties ===

Latest revision as of 14:59, 19 January 2010

The SailBlogs API (application prgram interface) provides a way for advanced users and developers to integrate SailBlogs information into external websites or applications. This is handled by calling the API via http 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.

Support

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

Usage: HTTP Requests, XML Responses

See API Usage Guide

PHP Class Reference

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

The Class includes the following properties and functions:

Properties

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

Functions

The following functions are available in the API Class.