Package: uservoice
:no_entry: [DEPRECATED] This repository is no longer actively maintained. You may fork the project but we are no longer accepting pull requests or new issues. You may reach out tosupport@uservoice.comwith questions.UserVoice Python module for API connectionsThis library allows you to easily:Generate SSO token for creating SSO users / logging them into UserVoice (http://uservoice.com).Do 3-legged and 2-legged UserVoice API calls safely without having to worry about the cryptographic details (unless you want).InstallationInstall the uservoice Python module from PyPI:pipinstalluservoiceor get the source from (http://pypi.python.org/pypi/uservoice) and use the setup.py method:pythonsetup.pyinstallNow you should be good to go!ExamplesPrerequisites:# Suppose your UserVoice site is at http://uservoice-subdomain.uservoice.com/USERVOICE_SUBDOMAIN='uservoice-subdomain'SSO_KEY='982c88f2df7257859e8e23423eg87ed'# Admin Console: Settings -> General -> User Authentication# Define an API client at: Admin Console -> Settings -> Channels -> APIAPI_KEY='oQt2BaunWNuainc8BvZpAm'API_SECRET='3yQMSoXBpAwuK3nYHR0wpY6opE341inL9a2HynGF2'SSO-token generation using the uservoice python librarySSO-token can be used to create sessions for SSO users. They are capable of synchronizing the user information from one system to another.
Generating the SSO token from SSO key and given uservoice subdomain can be done by calling UserVoice.generate_sso_token method like this:importuservoicesso_token=uservoice.generate_sso_token(USERVOICE_SUBDOMAIN,SSO_KEY,{'guid':1000000,'display_name':"User Name",'email':'mailaddress@example.com'},5*60)# the token will be valid for 5 minutes (5*60 seconds) by defaultprint"https://"+USERVOICE_SUBDOMAIN+".uservoice.com/?sso="+sso_tokenMaking API callsYou need to create an instance of uservoice.Client. Get API_KEY and API_SECRET for an API client which you can create from
Admin Console. Go to Settings -> Channels -> API.importuservoicetry:client=uservoice.Client(USERVOICE_SUBDOMAIN,API_KEY,API_SECRET)# Get users of a subdomain (requires trusted client, but no user)users=client.get_collection("/api/v1/users")print"Subdomain\"{subdomain}\"has{total}users".format(subdomain=USERVOICE_SUBDOMAIN,total=len(users))foruserinusers:print'User: "{name}", Profile URL:{url}'.format(**user)# Now, let's login as mailaddress@example.com, a regular userwithclient.login_as('mailaddress@example.com')asregular_access_token:# Example request #1: Get current user.user=regular_access_token.get("/api/v1/users/current")['user']print'User: "{name}", Profile URL:{url}'.format(**user)# Login as account ownerowner_access_token=client.login_as_owner()# Example request #2: Create a new private forum limited to only example.com email domain.forum=owner_access_token.post("/api/v1/forums",{'forum':{'name':'Python Client Private Feedback','private':True,'allow_by_email_domain':True,'allowed_email_domains':[{'domain':'example.com'}]}})['forum']print'Forum "{name}" created! URL:{url}'.format(**forum)exceptuservoice.Unauthorizedase:# Thrown usually due to faulty tokens, untrusted client or if attempting# operations without Admin Privilegesprinteexceptuservoice.NotFoundase:# Thrown when attempting an operation to a resource that does not existprinteVerifying a UserVoice userIf you want to make calls on behalf of a user, but want to make sure he or she
actually owns certain email address in UserVoice, you need to use 3-Legged API
calls. Just pass your user an authorize link to click, so that user may grant
your site permission to access his or her data in UserVoice.importuservoiceCALLBACK_URL='http://localhost:3000/'# your siteclient=uservoice.Client(USERVOICE_SUBDOMAIN,API_KEY,API_SECRET,callback=CALLBACK_URL)# At this point you want to print/redirect to client.authorize_url in your application.# Here we just output them as this is a command-line example.print"1. Go to{url}and click\"Allow access\".".format(url=client.authorize_url())print"2. Then type the oauth_verifier which is passed as a GET parameter to the callback URL:"# In a web app we would get the oauth_verifier via a redirection to CALLBACK_URL.# In this command-line example we just read it from stdin:access_token=client.login_with_verifier(raw_input())# All done. Now we can read the current user's email address:user=access_token.get("/api/v1/users/current")['user']print"User logged in, Name:{name}, email:{email}".format(**user)# To reuse the access token at a later point, store the token and secret. For example:# 1. Find user (in Django)u=User.objects.get(email=user['email'])# 2. Associate token and secret with the useru.access_tokens.create(system='uservoice',token=access_token.token,secret=access_token.secret)# When you need the token again:# 1. Find token of the current usertoken=u.access_tokens.get(system='uservoice')# 2. Use the token and secret to log inaccess_token=client.login_with_access_token(token.token,token.secret)