Difference between revisions of "SailBlogs API"
(→Class Reference) |
|||
| Line 7: | Line 7: | ||
=== Premium Account === | === Premium Account === | ||
Only SailBlogs [[Premium Memberships]] can be accessed via the API. | Only SailBlogs [[Premium Memberships]] can be accessed via the API. | ||
| + | |||
| + | ==Support== | ||
| + | Limited support is available for the API, and only via email. | ||
| + | |||
| + | ==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. | ||
| + | |||
| + | ==Base URL== | ||
| + | All calls to the SailBlogs API will be made to the following URL: | ||
| + | |||
=== PHP 5.0 or Greater === | === PHP 5.0 or Greater === | ||
| Line 12: | Line 22: | ||
* 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== | ==PHP Class Reference== | ||
Revision as of 11:21, 19 January 2010
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.
Contents
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.
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.
Base URL
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.
- 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
PHP Class Reference
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
- apiKey
- blogDirName
- blogID
- cache
- cacheLoc
- cacheFile
- cacheTime
Functions
The following functions are available in the API Class.
