Difference between revisions of "VZ-Login-Tutorial"

From VZ Developer Wiki
Jump to: navigation, search
(Step 1: Create a new service)
(Step 2: Copy your access data)
Line 18: Line 18:
[[File:step1.png | 650px]]
[[File:step1.png | 650px]]
=== Step 2: Copy your access data ===
=== Step 3: Copy your access data ===

Revision as of 13:57, 30 November 2010

A Step-by-Step Guide to using VZ as Your Login Handler

Why VZ-ID?

If your website requires authenticated users which have to sign up in first place, this process is usually considered as a conversion killer. Users are more likely to sign up if they can use their already existing credentials. This is where VZ-ID comes into play. It offers an easy-to-use API which integrates with your website's user management. The following guide will describe how the integration can be achieved with a few lines of code.

The following guide was created using a MeinVZ developer account, but it will work for the other platforms in the same fashion.


Before you can integrate VZ-ID you are required to sign in as a developer on either one of the following platforms: StudiVZ, MeinVZ or SchülerVZ. Your account will be activated after it went though our validation and approval process.

Step 2: Create a new service

Before you can use the API, you will be requested to create a "service" which contains information about your website that is about to use VZ-ID.

  • Service Name is just an identifier to help you to identify your current website among other websites and services you already created or you might create in future
  • Description describes the nature of your website
  • Callback URL must be an accessible URL within your domain. You will copy an HTML file there which will be provided later in this tutorial


Step 3: Copy your access data