Please Note this article is intended for apps that allow other PeopleVine users to login into it for added features. E.g. a content editor for PeopleVine users. If you're looking to authenticate your own customers into your app (where you already have a username and password for the authentication), please follow this tutorial.
So you've built a tool to make PeopleVine user's lives much simpler? Awesome, we're glad to have you here. In order for them to access your app, you will need to generate PeopleVine credentials that are accessible via your API key. You can do this by simply routing your users to the PeopleVine App Authentication screen.
Simply send your customers to https://control.peoplevine.com/app_authentication.aspx with the following parameters:
- track - this should be a random string that is sent back to you upon successful authentication in an effort to ensure they have routed through the PeopleVine authentication first
- reroute - this is the URL you would like us to route the user back to. Make sure you url encode the reroute value
- api_key - this is the API key of your application and is tied to the users credentials
An example of the URL would be:
Once successfully authenticated and they have an active subscription we will automatically return them to the reroute URL specified appending the track, user_username, user_password and auth_company_no which you can now store the credentials for the user access. The auth_company_no is the company_no in your auth structure.
Note: it's important that you still keep the user's credentials and your api_key encrypted to ensure others can't see it in plain sight.
To sum it up:
Follow these simple steps to authenticate your app with existing PeopleVine users:
- When logging into your app, route your customers to https://control.peoplevine.com/app_authentication.aspx?track=<track>&api_key=<api_key>&reroute=<url>
- Once they've authenticated with PeopleVine and given your app access, we will re-route them to your reroute URL and include their user_username, user_password, auth_company_no and the same track you sent.
- When you receive our call, simply store the data to be accessible via your AUTH string, mapping the user_username to username, user_password to password and auth_company_no to company_no for your calls to our API.
That's it, we'll manage the rest for you!