NIM

Custom REST connectors

Caution

Because it's possible to make REST calls in PowerShell, you can build custom REST connectors using either NIM's PowerShell connector format or its REST connector format.

The latter uses a proprietary REST engine that is potentially more resource- and code-efficient. However, the trade-off is that NIM's REST engine is not user-extensible, whereas PowerShell always is. If you choose to develop a custom REST connector and run into features that the engine doesn't currently support, you'll have to contact Tools4ever to request the necessary features to the REST engine. Your connector development will then be blocked until Tools4ever can add them.

Due to this trade-off, our currently-recommended best practice is to create source-only connectors using Custom PowerShell connectors. On the other hand, custom connectors which will be used in both source and target contexts should be created using the REST connector format. They tend to result in an overwhelming amount of PowerShell code and thus benefit more from the REST connector format, despite its potential drawbacks. See Sources and targets.

Additionally, if you've created a custom PowerShell connector which is underperforming, you may want to convert it to REST.

Contact Tools4ever if you need help with custom connector development.

A REST connector lets NIM connect to any external system that offers a REST API, and make arbitrary REST calls. It runs on NIM's proprietary REST engine.

A custom REST connector is composed of just a single JSON file. To get started writing a custom REST connector, copy C:\Program Files\Tools4ever\NIM\sysconfig\rest\systems\Google.json and edit it.

If the external system's API changes, you will need to update the connector's JSON file accordingly.

To test a custom REST connector, see REST connector test. We recommend thoroughly testing your connector any time the external system API changes, as well as after a NIM upgrade.