Home

Welcome to the OpenConext-api wiki!

A service connected to OpenConext as a Service Provider (SP) can actively retrieve personal information on the logged in user or his team memberships. OpenConext offers a RESTful web service (also called 'OpenConext API') for this. The OpenConext API implements the VOOTprotocol, which in turn is loosely based on the OpenSocial specification.

A complete specification of the OpenConext API can be found in the SURFconext API pages. Although in principle both APIs are the same and use the same code base, there are some minor implementation differences. Here, we will look at the specific differences between the SURFconext API and the OpenConext API.

Using the OpenConext API from a service means you must implement an OpenConext API client. Documentation is available on how this can be done using Java or PHP.

Note that the URLs used in the examples are for demonstration purposes only. To view in your own environment, modify the URL to match your installation.

##API Definition

For the full OpenConext API definition, see the SURFconext API definition page. The differences when using the OpenConext API are:

• OpenConext API location: https://api.demo.openconext.org/v1/social/rest
• SURFconext uses users and groups identifiers in an URN format. If your OpenConext instances uses something different, adjust the OpenConext API calls accordingly

API Security

For the full OpenConext API security support, see the SURFconext API security pages. The differences when securing the OpenConext API are:

• OAuth 2.0 endpoints: Authorization URL: https://api.demo.openconext.org/v1/oauth2/authorize AccessToken URL: https://api.demo.openconext.org/v1/oauth2/token
• OAuth 1.0a endpoints: Request Token: https://api.demo.openconext.org/v1/oauth1/requestToken Authorize: https://api.demo.openconext.org/v1/oauth1/confirm_access
• Access Token: https://api.demo.openconext.org/v1/oauth1/accessToken

API Playground

How you can use the OpenConext API Playground can be found on the SURFconext API Playground page. The differences when using the OpenConext API Playground are:

• API Playground URL: https://api.demo.openconext.org/v1/test

Before you can use the OpenConext API Playground, you need to register it an OAuth client in the OpenConext ServiceRegistry