Difference between revisions of "SailBlogs API"
From SailBlogs Support Wiki
(11 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | The SailBlogs API provides a way for advanced | + | 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 8: | Line 8: | ||
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. | ||
+ | |||
+ | ==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 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 | ||
− | + | The Class includes the following properties and functions: | |
− | |||
− | |||
− | |||
− | |||
− | |||
=== Properties === | === Properties === | ||
+ | *apiKey | ||
+ | *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: getXJEntries|getXJEntries]] | *[[SailBlogs API: getXJEntries|getXJEntries]] | ||
*[[SailBlogs API: getXJComments|getXJComments]] | *[[SailBlogs API: getXJComments|getXJComments]] | ||
*[[SailBlogs API: getContents|getContents]] | *[[SailBlogs API: getContents|getContents]] | ||
+ | *[[SailBlogs API: getPosition|getPosition]] |
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.
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.
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.
- 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
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.