- 3 minutes to read

Manage the Nodinite Web API

Empower your DevOps and integration workflows by automating Nodinite management with the Web API. This guide shows how to use REST-based operations to add, update, or manage artifacts—such as Integrations in the Repository—using your preferred programming language.

✅ Automate documentation and configuration as part of your DevOps pipeline
✅ Use REST-based API calls from PowerShell, C#, Java, or Node.js
✅ Streamline integration management and reduce manual effort

Tired of writing documentation? Make it part of your DevOps experience instead!
You can use the Nodinite Web API to automate almost everything related to Nodinite, such as adding or modifying artifacts like an Integration in the Repository as part of your DevOps routine. You can use almost any programming language to call the REST-based operations.

Tip

Use automation to keep your documentation up to date as part of your DevOps experience.

Programming Language Description
Powershell Easily call REST endpoints with built-in PowerShell cmdlets
C# Integrate with .NET applications using WebClient and JSON parsing
Java Connect to the API from Java-based solutions
Node.js Use Node.js and npm packages for automation

Powershell

You can easily use Invoke-RestMethod to call any method in the Web API.

$nodiniteBaseUrl = "http://localhost/Nodinite/Demo/WebAPI"
$nodiniteBaseApiUrl = "$($nodiniteBaseUrl)/api"

$getResponse = ""
$url = "$($nodiniteBaseApiUrl)/integrations"
$getResponse = Invoke-RestMethod -Uri $url -Method Get -UseDefaultCredentials
$getResponse.Collection.Items[0].Data.IntegrationId

Example: Retrieve the first Integration Id in the list of defined Integrations.

C# 

using Newtonsoft.Json.Linq;
using System;
using System.Net;
using System.Text;

namespace ConnectWebAPI
{
    class Program
    {
        static void Main(string[] args)
        {
            using (var client = new WebClient { UseDefaultCredentials = true })
            {
                client.Headers.Add(HttpRequestHeader.ContentType, "application/json; charset=utf-8");
                byte[] responseBody = client.DownloadData("http://localhost/Nodinite/Demo/WebAPI/api/integrations");
                var jsonBody = JObject.Parse(Encoding.ASCII.GetString(responseBody));
                var firstIntegration = jsonBody.SelectToken("Collection.Items[0].Data.IntegrationId");
                Console.WriteLine(firstIntegration);
            }
        }
    }
}

Java

Node.js 

// This example uses httpntlm (https://www.npmjs.com/package/httpntlm)
// Run: "npm install httpntlm --save" before running this script.

var httpntlm = require('httpntlm');
var url = 'http://localhost/Nodinite/Demo/WebAPI/api/integrations';

httpntlm.get({
  url: url,
  username: '{YourWindowsUsername}',
  password: '{YourWindowsPassword}'
}, function (err, res) {
  if (err) return err;

  var jsonBody = JSON.parse(res.body);
  var firstIntegration = jsonBody.Collection.Items[0].Data.IntegrationId;

  console.log(`First Integration Id: ${firstIntegration}`);
});

Example: Retrieve the first Integration Id in the list of defined Integrations.

Important

Your password should be protected. Use the Pre-Encrypt password feature in a real-world scenario.

Next Step

Log API