In simple terms, the Crowdicity API allows you to pull information from and put information into the Crowdicity system, without using the Crowdicity community interface.
By making use of the API and custom-built solutions, developers can open up the content of their Crowdicity community to any audience or any platform they wish.
Understanding the API
The Crowdicity API allows data on the community to be edited and retrieved.
It accesses the community via an existing or newly created user account, and has the same access rights as whichever account it is used through. The API mirrors the kind of operations a user would perform through the web browser.
The Crowdicity API is able to:
Retrieve information about challenges
Fetch lists of ideas from challenges
Get detailed voting and comment information for individual ideas
Retrieve visible user profile information
Create posts, comments and votes on behalf of the account through which the API is accessing the community
Through these types of calls, the API can be used for situations such as:
Retrieving ideas for analysis in another system
Showing latest ideas on a different platform or in a different format, such as an intranet
Creating a dynamic challenge list so users can visit them directly from another platform
Automatically post ideas based on another factor such as a daily schedule, to inspire discussion each day
Setting up access to the API
Access to the API must be requested through a user account and approved by community admins. It can be revoked at any time, ensuring that access to community data is always under the control of admins.
Once access has been granted, the Getting started guide shows developers how to use their API-enabled account to start making API calls: Crowdicity-API---Getting-Started.pdf
The calls themselves are detailed in the API reference guide, which can be accessed at the following link: https://api.crowdicity.com/doc/
Since we have multiple data-centers, please make sure to use the correct URL when calling the API.
Region - URL
The endpoints will remain the same. For example, a community in US-1 would use the following URLs: