Frequently Asked API Questions

Q: What is the Single Sign-On (SSO)? How can my learners log in to Voxy directly from my website or LMS?

A: The Voxy Partner API enables you to create a Single Sign-On experience for your users, whereby you can automatically log them into Voxy without the user needing a password. In order to accomplish this, you can request a URL from the Partner API that includes an auth_token that will allow the learner to be logged into the Voxy application.

In the body of the response from the API, you will receive a start_url. Whenever a user needs to access Voxy, you can request the start_url and redirect the user to the URL that is included, and the user will automatically be granted access to their account in Voxy.

IMPORTANT: the auth_token will be invalidated as soon as it is used or the next time the user logs into the Voxy platform. Therefore, you should request the login URL at the moment the user is attempting to access Voxy and request a new one each time the user needs to log in.

This capability allows you to create a seamless experience for their users. For example, you can create a login form on your website or inside your system where the user can click a button and be automatically logged in to Voxy, giving the impression that the user is interacting with the same system, when in fact they are interacting with two. For this reason, enabling Single Sign-On is often a required task that must be completed by white label customers.

 

Q: How can I revoke or deny access to a learner?

A: A learner’s access to Voxy is determined by the expiration_date saved on their user profile. Learners that have an expiration date past today are denied access to Voxy’s platform. If you need to deny a specific user from accessing the platform, then you should update their expiration date by making a PUT request to https://partner-api.voxy.com/partner_api/partners/users/{external_user_id}/ and including the expiration_date parameter with a date in the future.

 

Q: What is the difference between “stage” and “production” environments?

A: The “stage” environment is a sandbox, or testing, environment, that you can use for testing purposes while you are setting up your API integration. The “production” environment is the live environment that should be used with your real users. You should NOT do any testing in the production environment. You can create as many fake users as you need in the “stage” environment and do not have to worry about messing up real data.  

The different environments are accessed through different URLs:

You also need to use a different API_KEY and a different API_SECRET to for each environment.  Your Voxy Customer Success Manager can provide you with an API_KEY and API_SECRET for both the “stage” and “production” environments.

When you are ready to launch, your code should replace any references to the stage environment with references to the “production” environment. Your code will need to use a different domain in the endpoint URLs, and also use a different API_KEY, and API_SECRET and you will be creating real user accounts and requesting real user data.

 

Q: What is the difference between groups and segments?

A: A group, better described as a “feature group”, is a collection of learners that have access to the same set of Voxy features. For example, one feature_group may have access to private classes, while another group may not. Your Voxy Customer Success Manager will create feature groups based on the product packages your organization has purchased.

Segments, better described as “reporting segments,” are custom tags you can create and assign to users, and later use as filters in reports. For example, you might create segments to represent different locations or departments in your organization. Later, you can use these as filters on reporting data. For example, some endpoints in the Voxy Partner API will return data only for users that belong to a specified segment.

In addition, reports that are available in Voxy Reports are able to be filtered by any custom segments you have created.

Example: the Voxy Partner API has the following endpoint: […]  If you make a GET request to this endpoint, you will get a list of the group sessions attended by all the users in the specified segment.

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.