A Nova Marketing Group service
nCodeCloud
Sign in
Docsmenu

Info & token service

Two operational endpoints: one on nCodeWS4C1 itself, three on the companion token service nCodeWS4TS.

GetWebServiceInfo#

http
POST /GetWebServiceInfo

Returns version metadata for the running engine — most notably the address data version in production. Useful for cache invalidation, audit logs, and post-incident debugging.

json
{
"intRetCode": 0,
"strMessage": "OK",
"ServiceVersion": "4.10.1",
"AddressDataVersion": "2026-04",
"Capabilities": ["SERP-certified", "PoCAD-verified"]
}

Token service (nCodeWS4TS)#

The token service issues short-lived bearer tokens so a browser can call nCodeWS4C1 directly without exposing your license key.

If your backend calls nCodeWS4C1 server-to-server, you do not need the token service — send the license-key Authorization header directly. The token service exists for client-side integrations only.

GetToken#

http
POST /ts/GetToken
bash
curl $NCODE_TS_BASE/GetToken \
-H "Authorization: AcmeLogistics|nck_live_…" \
-H "Content-Type: application/json" \
-d '{ "DurationMinutes": 60 }'

Response:

json
{
"Outcome": true,
"Token": "tkn_…",
"ExpiresAt": "2026-05-21T18:30:00Z"
}

The browser then uses the token for subsequent calls:

javascript
fetch(`${NCODE_BASE}/OneStopAnalyze`, {
method: 'POST',
headers: {
  Authorization: token,            // not customer|key
  'Content-Type': 'application/json'
},
body: JSON.stringify(input)
});

Reuse the token across many calls — calling GetToken per request is wasteful. Refresh well before ExpiresAt.

GetMethods#

http
POST /ts/GetMethods

Returns the list of nCodeWS4C1 methods your license key is authorized to call. Rarely needed — use only if you've explicitly opted into per-method access controls.

GetStatus#

http
POST /ts/GetStatus

Returns credit balance, expiry, and pending renewal status for the license key. Programmatic way to surface overage warnings inside customer dashboards.