Difference between revisions of "CCAPI Library Component"
From ADF Docs
(Created page with '==Overview== This is a library utility which is packaged into the ADF. The library contains 3 CFC's which will help you: * [[CCAPI Element|Populate Content into a Textblock/Cust…') |
Gcronkright (talk | contribs) (→Config) |
||
| (11 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | ==Overview== | + | == Overview == |
| − | This is a library | + | CommonSpot contains a set of out-of-the box APIs that allows you to: |
| − | * [[CCAPI | + | * create pages |
| − | * [[CCAPI | + | * 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. | ||
| + | |||
| + | == 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 Configuration at the Site Level (XML)]] 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 - [[CCAPI Updating Elements |Populate Content into a Textblock/Custom Element]] | ||
| + | * csPage - [[CCAPI Create and Delete Pages|Create/Delete Pages]] | ||
| + | * csSubsite - [[CCAPI Create Subsites|Create Subsites]] | ||
=== Config === | === Config === | ||
| − | * [[ | + | * [[CCAPI Config|CCAPI Config]] |
| + | * [[CCAPI Conduit Page Pool|CCAPI Conduit Page Pool]] - new feature for v1.8 | ||
| + | |||
| + | <pre> | ||
| + | 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. | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | === FAQ === | ||
| + | * [[CCAPI FAQ|CCAPI FAQ]] | ||
| − | == | + | == Related Links == |
| − | + | * link to ccapi_1_0, csContent_1_0, csSubsite_1_0 Library Components | |
| − | [[Category: | + | [[Category:Project]] |
[[Category:CCAPI]] | [[Category:CCAPI]] | ||
Latest revision as of 15:00, 20 May 2016
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.
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 Configuration at the Site Level (XML) 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
- CCAPI Config
- CCAPI Conduit Page Pool - new feature for v1.8
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.
FAQ
Related Links
- link to ccapi_1_0, csContent_1_0, csSubsite_1_0 Library Components
