Difference between revisions of "CCAPI Library Component"
From ADF Docs
Gcronkright (talk | contribs) (→Overview) |
|||
| (14 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | ==Overview== | + | == Overview == |
| − | |||
| − | + | IMPORTANT: With the release of CommonSpot 11 and ADF 2.7 it is recommended to use the CommonSpot Custom Data API or the ADF's ceRecordAPI wrappers to 'populate custom elements' instead of using CCAPI. See the [[ceRecordAPI Reference]] for more info. | |
| − | + | ||
| − | + | 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 it 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 == | == CCAPI details == | ||
| − | The CCAPI is | + | The CCAPI Library Component is a bit different than other Library Components in that it is more like an Application than a library component. The CCAPI is 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 === | === CFC's === | ||
| − | * ccapi - Controls the main configuration of the | + | * ccapi - Controls the main configuration of the calls to the CommonSpot CCAPI |
| − | * csContent - [[CCAPI | + | * csContent - [[CCAPI Updating Elements |Populate Content into a Textblock/Custom Element]] |
| − | * csPage - [[CCAPI | + | * csPage - [[CCAPI Create and Delete Pages|Create/Delete Pages]] |
| − | * csSubsite - [[CCAPI | + | * csSubsite - [[CCAPI Create Subsites|Create Subsites]] |
=== Config === | === Config === | ||
| − | * [[CCAPI Config| CCAPI Config]] | + | * [[CCAPI Config|CCAPI Config]] |
| − | + | * [[CCAPI Conduit Page Pool|CCAPI Conduit Page Pool]] - new feature for v1.8 | |
| − | |||
| − | |||
| − | |||
<pre> | <pre> | ||
| Line 35: | Line 35: | ||
Content Creation API is not configured correctly. | Content Creation API is not configured correctly. | ||
</pre> | </pre> | ||
| + | |||
| + | |||
| + | === FAQ === | ||
| + | * [[CCAPI FAQ|CCAPI FAQ]] | ||
| + | |||
| + | == Related Links == | ||
| + | * link to ccapi_1_0, csContent_1_0, csSubsite_1_0 Library Components | ||
[[Category:Project]] | [[Category:Project]] | ||
[[Category:CCAPI]] | [[Category:CCAPI]] | ||
| + | [[Category: How-to Guide]] | ||
Latest revision as of 20:23, 5 February 2025
Overview
IMPORTANT: With the release of CommonSpot 11 and ADF 2.7 it is recommended to use the CommonSpot Custom Data API or the ADF's ceRecordAPI wrappers to 'populate custom elements' instead of using CCAPI. See the ceRecordAPI Reference for more info.
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 it 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 Library Component is a bit different than other Library Components in that it is more like an Application than a library component. The CCAPI is 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
