Obtaining a REST API Client ID

What do I need a REST API Client ID for?

In order to interact with the PKB REST API, you must identify yourself to PKB. The Client ID allows us to know who you are.

How do I get one?

Which type of REST API Client ID do you need?

PKB can offer you two types of Client ID. These are explained below. You are welcome to apply for both, or just get in touch if you think you have a situation that doesn't neatly fit into either.

System Client ID

You need a System Client ID if you are building a system that relies on a coordinator for an existing PKB site granting you permission to access their team's data. They will grant you this permission by manually generating OAuth2 tokens via the web interface for you to use. For example, perhaps you are building a specialist service which will integrate with a hospital that is an existing customer of PKB.

The benefit of a System Client ID is that you will automatically have access to both CLINICIAN and TEAMCOORD scoped REST API operations, without needing to maintain two connections. In addition, you will not need to provide a redirection URI.

User Client ID

You need a User Client ID if you wish to provide a service to any PKB user that agrees to grant you access to their account. For example, you might be building a mobile App and wish to let patients link their PKB account to your product. If you'd like a User Client ID you'll need to provide PKB with a redirection URI which we will use as part of the OAuth2 workflow. If a PKB user chooses to grant you permission, you will prompt them to manually enter their credentials to a PKB hosted landing page as part of the process. You will then be able to access that user's PKB account, via the REST API, using the tokens generated.

When requesting a User Client ID, we'll agree with you which scopes (user types) you have been approved for. Any connection you make will be limited to functionality accessible by the authenticated user.

How do I get access to live patient data?

Start by filling out the information sharing agreement to receive data from PKB so the PKB team can audit your information governance practices.
Comments