Skip to content
Wim Vandenhaute edited this page Mar 16, 2016 · 50 revisions

If you have absolutely no idea what linkID is, please visit www.linkid.be first.

We have SDKs for Java, PHP and .NET.

The WSDL for the linkID API can be found here

All calls to the linkID API need to be authenticated. For this WS-Security is used. You can choose between the X509TokenProfile and the UsernameTokenProfile.

To setup an application within the linkID system and get credentials to start talking to the API, please contact the linkID team @ [email protected].

There are 2 main categories on how to integrate linkID, online and offline, explained below. It's important to note that linkID payments is a feature which is piggybacked on the authentication flows. Have a look at the payment section later on to learn more about the possibilities.

Online

Here the linkID authentication session is started by the user clicking a login with linkID link in a webapp, mobile client.

Check following sequence diagram to understand what happens under the hood.

linkID Synchronous authentication

linkID authentication options

Learn more about the possibilities here.

linkID payment

As explained, linkID payments are piggybacked on the authentication flow.
Learn more about the possibilities here.

Offline

Here a Long Term QR code is generated by the application ( short: LTQR ). This LTQR code contains the necessary information linkID needs to start a linkID authentication session. When a linkID user scans this code, a new linkID authentication session is created using the LTQR information.

Think of sending an invoice via e-mail, showing a re-usable subscribe action to be displayed on a poster in a public space, ...

Learn more about the possibilities here.

Check following sequence diagram to understand what happens under the hood.

linkID LTQR

Notifications

Applications integrated with linkID can subscribe to certain linkID events like payment order updates, LTQR updates, ...

Learn more about it here.

Callback

Upon finishing a linkID authentication session, you can provide a callback page which the linkID app will open when finished.

Learn more about it here.

Check following sequence diagram to understand what happens under the hood.

linkID Callback

Themes

Attribute WS

linkID provides a WS to fetch a linkID user's attributes.

Learn more about it here.

Configuration

linkID provides some configuration operations to fetch linkID themes available to an application, certain localization values, ...

Browser polling

linkID provides an easy-to-use angularJS directive for this.
You can also have a look at the angularJS integration example

Learn more about it here.

Integration examples

Clone this wiki locally