Important Ecosystem Guidelines

These guidelines must be followed by all clients in order for us to work towards a streamlined and efficient login experience to all users. These guidelines will also help us reach a higher share of logged in users throughout the ecosystem of products and services that has implemented SPiD. Everybody wins!

Web applications

What:

Always implement the JavaScript SDK

Why:

  • Ability to perform cross-site autologin on returning visitors
  • Answers if user need to accept your TOS or not
  • Helps clients automatically retrieve tokens for API access for logged in users
  • Tells client when a user is logged out centrally and/or if the logged in user has changed in SPiD

What:

Use the JavaScript SDK provided by SPiD, do not develop your own

Why:

  • The SDK will be actively maintained by SPiD together with the community
  • You may contribute to it on Github

What:

Check that your implementation follows the login flow

Why:

  • This flow documents every state a user visiting your site might have
  • It will improve the stability of your implementation and the user experience of your users

What:

Make sure that when user logs out, you trigger a logout from SPiD

Why:

  • Respect the user’s choice when they choose to log out
  • Consistency in the expected behaviour of a logout button/link
  • To avoid confusing people and to protect personal security, we enforce this logout behavior

Mobile applications

What:

Use the official SPiD SDKs, do not develop your own:

Why:

Native apps that don’t use our SDKs will:

  • not be offered technical support
  • not have new introduced features like cross-app logins

Branding of SPiD

What:

Comply with the SPiD brandbook and guidelines

Why:

We need to offer a consistent and recognisable login experience across all products and services in the ecosystem

Guides

To-the-point technical guides that get you started with the SPiD API.

Getting started with the API

Connect your application to the SPiD API and make your first call, verify that your client ID and secrets are correctly configured.

Single Sign-On

Implementing Single Sign-On, how users log into your application via SPiD, and how you can access the SPiD API on their behalf.

Mobile development

Guide for native mobile development using the SPiD API.

Payment provider

Using SPiD as a payment provider, your users can purchase products via SPiD, and you can track their purchases in your application to give access to products and pages.

Working examples

So you prefer to dive straight into the code? Here are some example repos that work out of the box.

Implementing Single Sign-on

Using SPiD as a payment provider

Official API clients and SDKs

SPiD provides officially supported API clients (SDKs) for several languages. All our libraries are hosted on GitHub, feel free to report any issues, send pull requests, or just have a look at the source.

Server-side client libraries

These libraries can be used to integrate with SPiD server-side. Directions for installation and basic use can be found in our getting started guide.

Client-side SDKs

These libraries solve different use cases than the server-side ones, and are generally more feature rich. They are designed to build client-side apps.

Other libraries

These libraries are currently not officially supported and/or well documented, but you are welcome to give them a try.

API reference

Looking for API details? Here you will find extensive reference documentation of all API endpoints.


Didn't find what you were looking for? See the list of deprecated endpoints. New order and payment method APIs can be found here: Payment Platform Confluence