Skip to main content Link Menu Expand (external link) Copy Copied
Ons API

Ons API Dashboard - Specify a connector

Before you can navigate through the development stages, you must specify (a version of) the connector. This is specified based on the functional design and the technical design.

Functional Design

The functional design is a description of the version of the connector. The information from the functional design is visible to healthcare organisations in the ‘Ons Diensten’ application.

The data in the functional design can only be adjusted when the version is editable. Make sure the information is correct before you lock the version.

Descriptions

  • Product description
    Naming in Ons Diensten: ‘Beschrijving’
    Here you specify which services the underlying product offers, not being the (version of the) connector.

  • Summarized connector description
    Naming in Ons Diensten: ‘Korte beschrijving’
    Here you briefly describe in 140 characters what this (version of the) connector does.

  • Connector description
    Naming in Ons Diensten: ‘Over de koppeling’
    Here you elaborate on what this (version of the) connector does.

  • What problem is being solved?
    Naming in Ons Diensten: ‘Toepassing’
    Here you indicate the added value of the (version of the) connector.

When creating a new version, descriptions are automatically carried over, with the latest version serving as the source.

Healthcare Organisation

Fill in the details of the healthcare organisation actively involved in the development of the connector under ‘Shared customer’.

Technical Design

The technical design can be changed when the version is editable.

In the technical design, you specify:

  • Which data is exchanged. You do this by selecting models and indicating which operations and fields are required.
  • Optional: which authorizations are applicable, by enabling specific rights. See also: Authorization in Ons.

From a data minimization perspective, it is important to only exchange data necessary for the actual linkage; no data that is not efficient should be exchanged. See also Data minimization / filtering.

Models

Via the models, you can specify which data is exchanged. You select the ones you want to use.

Healthcare organisations using this (version of the) connector see an overview of the specified models in Ons Diensten.

CRUD Operations
For each model, you can select which CRUD (Create, Read, Update, Delete) operations you want to be able to perform. The available operations may vary per model and depend on the available endpoints for that model. You do not need to specify which exact endpoints you want to use.

The list of available endpoints can be found under API’s.

Sandbox mode
To simplify work during the development stage, the ‘Sandbox mode’ switch is present.

  • If it is on?
    Then only specified data is exchanged.
  • If it is off?
    Then no filtering is applied, and calls can be made on all endpoints.

Sandbox mode must be disabled before a request can be made to move the connector to the ‘production’ development stage.