UDS API / Client examples

Runnable client examples

Create synthetic evidence with IDs returned by the API. These examples require an authorized test credential and make persistent records in that credential's scope.

Choose a client

Start with a working example.

01 / ShellBash + curl + jq

curl / Bash

Source, session, exact byte read-back, partial observation and durable batch status. Requires Bash, curl and jq.

Open Bash example
02 / JavaScriptNode.js 22+

Node.js

The same workflow with bounded retries, strict response checks and no third-party dependencies. Requires Node.js 22 or later.

Open Node.js example
03 / Test dataJSON

Synthetic fixtures

Complete, partial, unavailable and deliberately invalid payload examples.

View fixtures

Read the quickstart before running either client. Use the same UDS_RUN_ID to resume an interrupted run without creating another set of evidence.

What the examples verify

Expected outcomes are exact 22F186 complete bytes, the 623F06 partial prefix with offset zero, stable IDs on a repeated request, rejection of invalid hex, and inspectable terminal batch outcomes.

No VIN, ECU family, supplier, timestamp, CAN identifier or response is invented. The fixtures are not licensed OEM definitions or a claim of compatibility.

Private credentials

Supply UDS_TOKEN separately through environment or secret storage. Do not paste real tokens, capture logs or customer identities into these files. Do not enable shell tracing while a credential is present.

Public examples demonstrate the request contract. Production performance, retention and recovery require separate operational acceptance.