UGC API Overview


Agility has a sub-system dedicated to the management and moderation of User Generated Content (UGC).  This refers to content on your site that is submitted by your site users, rather than by the editors in Agility.  The most common types of User Generated Content are things like comments, ratings, votes, and reviews.  You can also set up custom UGC types for text content, videos and photos to collect specific content for a website, contest or campaign.

The UGC component includes an area for collecting user profile data for your website users.  You can customize the fields that you want to collect and integrate user profiles with the authentication logic on your website or application. The process of setting up what fields you want to collect is covered in Setting up UGC Definitions.

The Agility UGC component is a stand-alone system that can be integrated into your website or application using the UGC API.  Whereas the Agility Web Content Managment component is based in, The UGC API is based on an open API and it can be integrated into sites on any platform including PHP, or simple HTML and JavaScript.  You can also use the API to integrate UGC into your mobile sites or apps.

The Agility UGC component can also be used together with the WCM component to add User Generated Content functionality to your Agility managed website.

The content types that you require, along with the fields you wish to collect, are configured using a graphical user interface in the Agility Content Manager.  Using the Content Manager, you can also set up moderator users and indicate what content they have access to moderate.  Moderators log into the Content Manager to view and approve or decline in coming User Generated Content.

There are several APIs for User Generated Content built into Agility. A summary of each is below:

  • Authentication

    • In order to authenticate to the UGC API, you need to initialize it using an API Key and Password.  This can be obtained by contacting us at For details on API setup see UGC API Setup

  • UGC Core API

    • The core UGC API allows you to create custom record types (similar to content definitions) and then read/write data from your website

  • Feedback API

    • The User Generated Content Feedback API provides the ability to store "flag" based data that you may need from your users. Some examples would be Likes, Votes, Ratings, Approval/Disapproval, etc. The API is built to be lightweight and fast to add and retrieve data on the fly. It is also built in a generic way so that you can "Flag" any content you may want to track in any custom scenario.

  • Website Users API

    • The user profile API provides the ability to interact with the User Content section of User Generated Content without having to custom code standard usage scenarios. The user profile API provides simple authentication, authentication validation and password reset.

  • UGC Comments API

    • Comments can be enabled on a content definition or UGC Record Type. When Comments are enabled a new UGC Comment Record Type will be created to store the comment content items.



1 out of 1 found this helpful



Please sign in to leave a comment.