Forum Discussion

deon's avatar
deon
Contributor
11 years ago

REST API Documentation

Hi, All

 

We are new to lithium, we want to find out the following:

 

1. How do we get a api access key.

2. where can we get access to the crowd sourcing api?

 

We found that the community api documented very well but could not find the documentation for crowdsourcing.

 

Regards

Deon

  • NicoB's avatar
    NicoB
    Lithium Alumni (Retired)

    Hi @deon,
    you don't need an API access key to access Lithium's REST API.
    Once you have access to a Lithium instance you can invoke REST API by simply accessing the restapi/vc endpoint (for example, if you perform a call to community.lithium.com/restapi/vc/users/self you will get details about your own profile.
    Obviously this is true only if the instance has the REST API read permissions enabled.

    What exactly do you mean by "crowd sourcing" API?


    Nico

    • deon's avatar
      deon
      Contributor

      Thanks for your reply Nico, 

       

      what i mean by crowdsourcing is.  We have a very specific requirement to do the following:

      User/communities should be able to 

       

      • Submit Ideas
      • Vote On The Ideas
      • choose the Best Ideas 

       

      You have this on the website, what i would like to know is if you have this api documented, and weather its needed to have a API key

       

      http://www.lithium.com/products-solutions/crowdsourcing-ideas

       

      Regards

      Deon

      • NicoB's avatar
        NicoB
        Lithium Alumni (Retired)

        Hi deon ,

        Idea is one of the many Lithium's module.

         

        If the instance you're working on has this module enabled than you can definitely using our REST APIs to access ideas.

         

        Bear in mind that Idea is a paid feature so you should check out with your Lithium contact to see whether the module is actually enabled.

         

        Thanks,

        Nico