Getting Started

Try it out

If you want to try out IKJ API without coding, there are two options:

• From OpenAPI pages: IKJ-API Test
• GitHub code example: KOMSAT.Samples

Both options use parent organization number 315945062. The OpenAPI pages use HelseID's Test-token-tjeneste for authentication. The code example uses a multitenant client configuration owned by NHN. Please note that sharing the private key, as is done in the example, is poor practice, and should never be done in production!

Step-by-step guide - TEST

This step-by-step guide demonstrates how to get started with IKJ API in Test.

1. Access through HelseID: You need a client configuration with access to IKJ API. You can create this yourself using HelseID Self-service.

   • Add access to API IKJ/nhn:ikj, and its scopes.
   • For single-tenant, select the organization number you want to act on behalf of.
   • For multi-tenant, add simulated delegation from the organization number you want to act on behalf of.

2. Configure your application using the client configuration. Be advised to use a recommended library for HelseID-authentication, such as HelseID.Library. For other recommended libraries, see HelseID docs.

3. Check the IKJ API documentation for available endpoints and how to use them. If you want to use an organization populated with test data, you can use the organization number 315945062 in your HelseID client.

Getting Ready for Production

The following must be done before you can use IKJ API in production:

1. Your HelseID client must be approved for Production.
2. Your organization must be member in Helsenettet
3. Order access to the VKP service (IKJ is a part of VKP)
4. The municipality must delegate access, so you can obtain access tokens with their organization number.