ALL SYSTEMS OPERATIONAL API 99.99%
v4.2 · BUILD 20260527
DEVELOPER · API

The NgineAgent API.
One interface to the engine.

A single API to NgineAgent — the deterministic validation and correction engine behind all ten products. Validate every field against industry rulesets, apply deterministic corrections, and export a clean master with a full evidence chain. Currently in private access for partners and enterprise customers.

— OVERVIEW

One API. One engine, ten products.

The same engine drives every product, so the interface is identical across them. Same input produces the same output and the same score — no drift. The engine runs inside your infrastructure with no external calls and no data retention. Calls are made over HTTPS to api.northernstarsystems.com.

Versioned

All endpoints sit under /v1/. Breaking changes ship as /v2/ with at least 12 months overlap.

Raw in, clean out

Requests and responses are JSON. Raw CSV/XLSX inputs are accepted via the /v1/ingest endpoint and read server-side by the engine.

Deterministic

The engine is stateless. Same input returns the same output and the same score — no drift. POSTs also accept an Idempotency-Key header.

— AUTHENTICATION

Bearer tokens, scoped per product and environment.

Tokens are issued per product (HeyRoya, Kataloghub, CIP, MediReady, PerfectBook, Inspection) and per environment (sandbox or production). Rotate at any time from the dashboard or by emailing us.

# Every request carries a bearer token in the Authorization header. curl https://api.northernstarsystems.com/v1/validate \ -H "Authorization: Bearer ns_live_•••••••••••••••••" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: 8f3c-…" \ -d '{ "product": "kataloghub", "ruleset": "v1", "job_id": "job_a91f…" }'

Sandbox tokens are prefixed ns_test_, production tokens ns_live_. Sandbox runs never touch live data. Token leaks should be reported to security@northernstarsystems.com.

— ENDPOINTS

Endpoint reference.

The engine's operations map to endpoint families: validate, correct, evidence, ingest, and webhooks. Full reference docs ship with sandbox access.

Coming soon
POST/v1/validate

Validate

Check every field against the industry rulesets for the target product without mutating anything. Returns a structured list of pass/fail rules with reasoning. Same input returns the same result.

Coming soon
POST/v1/corrections

Correct

Submit a raw payload. The engine applies deterministic corrections and returns a corrected version with a per-field diff. Edge cases the rulesets cannot resolve return a review_required flag.

Coming soon
GET/v1/evidence/*

Evidence chain

Retrieve the full evidence chain for a run by job ID — the report, the worksheet, and the corrected master. Every correction traces back to the rule that produced it.

Coming soon
POST/v1/export

Export master

Export the clean master from a completed run as corrected CSV, XLSX, or branded PDF. Deterministic output: same input, same master, same score.

Coming soon
POST/v1/webhooks

Webhooks

Subscribe to validate, correct, and export events. Signed payloads (X-NSS-Signature), exponential backoff retry, 30-day event replay.

Coming soon
POST/v1/ingest

Ingest

Stream raw CSV/XLSX files into the engine. Async by default with a job ID for polling or webhook delivery. The engine runs in your infrastructure — no external calls, no data retention.

— LIMITS · SDKS

Rate limits and client libraries.

Standard limits below. Enterprise plans negotiate custom limits and dedicated infrastructure.

60

Sandbox

Requests per minute per token, across all endpoints. Use for development and CI.

600

Production

Requests per minute per token. Standard for SaaS plans. Burst headroom available.

Enterprise

Dedicated infrastructure, custom limits, SLA-backed throughput. Talk to us.

— OFFICIAL SDKS

Python

In development. pip install northern-star on private index for partners.

Node.js

In development. npm i @northern-star/sdk on private registry.

Go

In development. Generated from the OpenAPI spec; module path shared with sandbox access.

Building on the engine? Let's talk.

Sandbox access, integration support, and a live walkthrough of the validate, correct, and evidence operations that match your product. We respond within one business day.

Request API access →