API Types

  1. API Reference
    1. API Types
    2. Class Types
    3. JSON API
    4. XML API
    5. Session API
    6. JSON and XML APIs - Asynchronous API Responses
    7. Server Class Method Reference {#apiserverclass}
    8. System Class Method Reference {#apisystemclass}
  2. System Accounts
  3. Advanced Configurations
    1. Dual v3/v2 Deployment
    2. Using centovacast.conf
  4. Command-line Tools
    1. Controlling Centova Cast
    2. Diagnostic Report Generator
    3. Fixing Problems
    4. Centova Cast Management Utility
      1. Management Utility Invocation
      2. Output Formats
    5. Reinstalling Centova Cast
    6. Uninstalling Centova Cast
    7. Update Utility
  5. Customizations
    1. Init Script
    2. Menu Customizations
    3. Wrapping Server Applications
  6. Event Scripts
    1. Event Script Reference
    2. Event Notification Scripts
    3. Event Script Structure
  7. Files and Paths
    1. Account Files and Paths
    2. Core Files and Paths
    3. Formats
      1. nextsong.log File Format
  8. Plugins
    1. Event Script Reference
    2. Example Plugin
    3. Plugins API
    4. Plugin Structure

API Types

For developer convenience, Centova Cast provides multiple application programming interfaces (APIs) to access its internal management functionality. All of the interfaces are functionally identical, and simply serve as alternate front-ends to the same back-end functionality.

Centova Cast itself uses an internal, native interface to the same management functionality in its own web interface, thereby ensuring that the results of any operation performed via the API will be identical to the results of performing the same operation via the web interface.

JSON API

The Centova Cast JSON API provides a simple HTTP GET/POST-based interface to the API which returns JSON-encoded responses. Simple JSON manipulation libraries are available for almost all programming languages, making this a convenient and easy-to-use integration option.

XML API

The Centova Cast XML API provides a simple XML-over-HTTP interface to the API which accepts and returns XML-encoded requests and responses. Much like JSON, XML is almost universally supported across all programming languages for convenient integration with third-party applications.

Session API

The Centova Cast Session API provides an interface similar to that of the JSON API, except that it works with the current user's login session and is designed to be used to implement custom functionality in the Centova Cast web interface via AJAX requests.

Commandline

The Centova Cast Commandline Management Utility provides a basic interface to the Centova Cast automation API that can be used from the UNIX shell prompt or shell scripts.

Previous: API Reference
Section: API Reference
Next: Class Types