WhiteBeard News Suite API

This API is for communicating with WhiteBeard News Suite components.

Overview

All API calls are made via HTTPS. Data type returned is always a JSON, unless otherwise modified by a specific request. For example, you can request articles to be returned in XML, NewsML, Facebook Catalog, or MSN News format.

Authentication

You must send an API key token to identify your application. You can specify an API key by adding a GET or POST variable:

key=ABC123

By specifying an API key, you gain permission to view all publicly readable content. If you wish to perform actions that require authorization, make sure that your API key is authenticated.

WARNING: An authenticated API key must be kept secure at all times. Do not use authenticated keys on client-side apps such as a JavaScript apps or mobile apps.

Endpoint

Your installation's API is accessible via:

https://your_server_hostname/cmsapi/

Modules

There are various modules that can you interface with.

Content

• Articles
• Videos
• Authors
• Categories
• Pages
• Classifieds
• Keywords

User & Personalization

• Visitors
• Ecommerce
• Channels
• Feed

Notes on property types

You will notice in various references that some values have types, such as string or integer. In JSON format outputs, all integer or numeric values are provided inside strings. The type is only mentioned for your processing needs.

Feedback

If you have any feedback on the API, please send your request to support@whitebeard.me.