REST Connectors
Danger
It is important to note that developing Connectors or Scripts comes with a "Use at Your Own Risk" policy. We would like to emphasize that any such tools, connectors, or scripts that have not been developed directly by Tools4ever are outside the scope of our standard support services. Users are advised to exercise caution and discretion when employing any non-official tools or scripts in conjunction with Tools4ever products.
A NIM REST connector file contains the following root structure:
{
"$schema": "https://schemas.nimsuite.com/rest-connector.json",
"schema": {},
"rest": {},
"connection": {},
"config_scenarios: [],
"version": "1.0"
}- $schema
The $schema element in a connector's JSON configuration specifies a path or URL pointing to a schema definition file, such as a JSON Schema or similar standard. This file outlines the structure, required fields, and data types expected within the connector's configuration. By including the $schema property, editors like Visual Studio Code (VSCode) can utilize the referenced schema to provide real-time validation, syntax highlighting, and IntelliSense (auto-completion) for the JSON configuration.
This helps ensure that the connector's JSON file adheres to the expected format, reducing errors and improving developer productivity. For example, the schema might enforce rules such as which fields are mandatory, permissible values for enumerations, or the expected data types for each field, such as strings, integers, or arrays.
- schema
The connector's schema object defines all resources and CRUD calls supported by the system.
- rest
Provides the global request settings, including authentication and pagination.
- connection
(Optional) Used to specify additional system connection settings for the connector.
- config_scenarios
The config_scenarios element is an array of objects designed to store pre-defined configuration sets for a system. Each configuration set captures tables, fields, data types, and relational configurations required for a specific integration scenario. These configurations are built and exported within the NIM system after it has been fully set up and validated. Once exported, the configuration sets are included in the connector's config_scenarios array, enabling seamless reuse and consistency when importing configurations. This approach streamlines setup processes by ensuring the connector is preloaded with all necessary metadata for integration, reducing manual effort and minimizing the risk of errors during deployment.
The schema property is the most complex part of the connector.