Skip to content
Wim Vandenhaute edited this page Mar 17, 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 @ help@linkid.be.

Next to a regular linkID session, there exists also a possibility to distribute an offline version of a linkID session. There are 2 main categories on how to integrate linkID, online and offline, explained below.

It's important to understand that linkID payments is a feature which is piggybacked on the authentication flow. Have a look at the payment section to learn more about the possibilities.

linkID Session

A linkID session can be shown to the user in the form of a QR code or as an URL. The former is typical when a user tries to log in from a non mobile device, the latter from a mobile device with the linkID mobile app installed.

Learn more about the possibilities here.

Offline distribution

Here a configuration for a future linkID session is generated. The application can generate these whenever he wants and will get a QR code representation of it as well as an URL ( for on mobile devices ). When the linkID user scans or clicks on it, the linkID app will tell the linkID backend to start a new linkID session from this the configuration behind it. We call this feature the Long Term QR code ( short: LTQR )

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.

Payments

linkID payments are piggybacked on the authentication flow.

Learn more about the possibilities here.

Wallets

linkID has a concept called wallets, which allows applications to enroll linkID users for a specific wallet, add credit to that wallet, allow a user to pay with credit from a certain wallet, ...

You can ask a linkID operator to create a wallet organization. You can request to give permission to other applications to enroll, add credit, remove credit, fetch reports, ...

Learn more about the possibilities here.

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.

Themes

You can customize the log in and payment screens of the linkID mobile app using linkID themes. Beside your application logo, you can configure multiple themes which can have a different background, fallback background color, text color.

Learn more about it here.

Data WS

linkID provides a feature where an application ask a linkID operator to define certain data attributes. These are attributes which the application can then create, read, update, delete without the user having to give permission for it. The only requirement is that the user has an active subscription to the application. Think of for example a memberType attribute you wish to push to linkID ( PREMIUM, NORMAL, ... ). These attributes could then be used by other applications if given the right to.

Learn more about it here.

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