Difference between revisions of "CCAPI Library Component"
m (moved CCAPI to CCAPI Library Component: This will conflict with the Actual CCAPI component) |
|||
| Line 1: | Line 1: | ||
| − | == | + | == Overview == |
| − | CCAPI | + | CommonSpot contains a set of out-of-the box APIs that allows you to: |
| + | * create pages | ||
| + | * upload images | ||
| + | * upload documents | ||
| + | * create subsites | ||
| + | * populate textblock elements | ||
| + | * populate custom elements | ||
| + | |||
| + | Note: For more about the CommonSpot CCAPI refer to the CS Developers Guide | ||
| + | |||
| + | The CCAPI Library Component is designed to "sit on top" of the standard CommonSpot CCAPI. The goal of the CCAPI Libaray Components is to make easier for you to populate content in CommonSpot programmatically. | ||
| + | |||
| + | This page outlines the components contained within the CCAPI Library Components and gives links to detailed pages about how to use those components.1 | ||
== CCAPI details == | == CCAPI details == | ||
| − | The CCAPI is actually a series of components in combination with a configuration file that piggybacks on top of the [[ | + | The CCAPI Libaray Component is a bit different than other Library Components in that it is more like an Application than a library component. The CCAPI is actually a series of components in combination with a configuration file that piggybacks on top of the [[Application Site Config]] framework. Below is a list of the Components located in the /ADF/lib/ccapi/ directory and what they are used for. |
=== CFC's === | === CFC's === | ||
| − | * ccapi - Controls the main configuration of the | + | * ccapi - Controls the main configuration of the calls to the CommonSpot CCAPI |
* csContent - [[CCAPI Element|Populate Content into a Textblock/Custom Element]] | * csContent - [[CCAPI Element|Populate Content into a Textblock/Custom Element]] | ||
* csPage - [[CCAPI Page|Create/Delete Pages]] | * csPage - [[CCAPI Page|Create/Delete Pages]] | ||
| Line 14: | Line 26: | ||
* [[CCAPI Config| CCAPI Config]] | * [[CCAPI Config| CCAPI Config]] | ||
| − | |||
| − | |||
| − | |||
<pre> | <pre> | ||
| Line 23: | Line 32: | ||
Content Creation API is not configured correctly. | Content Creation API is not configured correctly. | ||
</pre> | </pre> | ||
| + | |||
| + | == Related Links == | ||
| + | * link to ccapi_1_0, csContent_1_0, csSubsite_1_0 Library Components | ||
[[Category:Project]] | [[Category:Project]] | ||
[[Category:CCAPI]] | [[Category:CCAPI]] | ||
Revision as of 00:00, 30 March 2010
Overview
CommonSpot contains a set of out-of-the box APIs that allows you to:
- create pages
- upload images
- upload documents
- create subsites
- populate textblock elements
- populate custom elements
Note: For more about the CommonSpot CCAPI refer to the CS Developers Guide
The CCAPI Library Component is designed to "sit on top" of the standard CommonSpot CCAPI. The goal of the CCAPI Libaray Components is to make easier for you to populate content in CommonSpot programmatically.
This page outlines the components contained within the CCAPI Library Components and gives links to detailed pages about how to use those components.1
CCAPI details
The CCAPI Libaray Component is a bit different than other Library Components in that it is more like an Application than a library component. The CCAPI is actually a series of components in combination with a configuration file that piggybacks on top of the Application Site Config framework. Below is a list of the Components located in the /ADF/lib/ccapi/ directory and what they are used for.
CFC's
- ccapi - Controls the main configuration of the calls to the CommonSpot CCAPI
- csContent - Populate Content into a Textblock/Custom Element
- csPage - Create/Delete Pages
- csSubsite - Create Subsites
Config
Note: Refer to the CommonSpot Developers Guide for information on how to configure the standard CommonSpot Content Creation API. The ADF CCAPI will not work if the CommonSpot Content Creation API is not configured correctly.
Related Links
- link to ccapi_1_0, csContent_1_0, csSubsite_1_0 Library Components
