Ons API Dashboard - Specify a connector

A connector is specified through its functional design and Ons® API Models.

Functional Design

The functional design is a description of the version of the connector.

The version details can only be changed while the version is draft. Check that the information is correct before you lock the version.

Descriptions

• Product description
  Here you specify which services the underlying product offers, not being the (version of the) connector.

• Summarized connector description
  Here you briefly describe in 140 characters what this (version of the) connector does.

• Connector description
  Here you elaborate on what this (version of the) connector does.

• What problem is being solved?
  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.

Ons® API Models

Models can only be changed while the version is draft.

In Ons® API Models, specify which data is exchanged by selecting the models and the operations and fields the connector needs.

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.

CRUD Operations
For each model, select the CRUD (Create, Read, Update, Delete) operations you need. The available operations may vary by model. Selecting operations gives access to their endpoints; you do not need to select individual endpoints.

The list of available endpoints can be found under APIs.

Sandbox mode

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

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

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

---