Skip to main content

Build REST Connectors

Developer guide

Build a maintainable NIM connector for a REST API—from connection settings and authentication through data tables and write operations.

Custom connector support

Custom connectors and scripts are used at your own risk. Tools4ever support covers connectors developed by Tools4ever; validate custom work in a non-production environment before deployment.

Start with the schemaDirect link to Start with the schema

Use the public REST Connector JSON Schema as the source of truth. Add it to every connector file for editor validation and autocomplete.

{
  "$schema": "https://schemas.nimsuite.com/rest-connector.json",
  "schema": { "crud_objects": {} },
  "rest": { "config": {} },
  "connection": { "items": [] }
}

schema and rest are required. connection and config_scenarios are optional. Do not set version when publishing a connector to GitHub; NIM generates it when downloading the connector.

config_scenarios stores configuration scenarios.

New to REST connectors?Follow the step-by-step connector tutorial, which uses Skyward Qmlativ as a real-world example.

Build in this orderDirect link to Build in this order

  1. Configure REST requests — base URL, authentication, headers, pagination, selectors, and retries. Use the authentication guide for API keys, OAuth grants, signed JWTs, custom tokens, and provider-specific examples.
  2. Model API objects — NIM tables, resources, keys, and optional group membership.
  3. Add operations — GET, POST, PUT, PATCH, and DELETE calls.
  4. Design the connection screen — expose administrator inputs safely in NIM Studio.
  5. Validate and test — collect data, then test each write operation with non-production records.

Validate in VS CodeDirect link to Validate in VS Code

{
  "json.schemas": [{
    "fileMatch": ["**/sysconfig/rest/systems/*.json"],
    "url": "https://schemas.nimsuite.com/rest-connector.json"
  }]
}
Last updated on