HS-Refractor_internal exposes a FastAPI application for Haag-Streit Refractor workflows. It supports NX-JSON read/write, configuration, API keys, version information, card operations, licensing, logs, and UI pages.
The route list below is based on HS-Refractor_internal/api.py.
Protected routes use:
Authorization: APIKey <key>
Three key roles exist:
| Role | Purpose |
|---|---|
read |
Access to JSON read route. |
write |
Access to JSON write route. |
settings |
Access to config and key routes. |
API-key requirements are controlled by config.json under API.key_requirement. Localhost is allowed for selected administration operations.
Route paths are configurable:
| Config key | Default |
|---|---|
API.json_get_route |
getjson |
API.json_post_route |
postjson |
In practice, deployments usually expose:
GET /getjsonPOST /postjson/postjsonReceives NX-JSON and passes it into the configured interface handler.
Access:
Behavior:
nxJSONvalidator.nxJson_validator(data);data["nx-data"]["entryPoint"] to the API interface name;message_handler(data, ...);Success response:
{
"Status": "success"
}
Validation error:
422nx-JSON format not matchedHandler failure:
500/getjsonReturns the latest JSON data that was written to the API interface.
Access:
Behavior:
latest_data;nexSoft;API:getjson entry into the datalog./getconfigReturns the current configuration with non-editable or sensitive fields removed or encrypted.
Access:
Response:
{
"data": {},
"encrypted": false
}
Behavior:
/postconfigUpdates configuration.
Access:
Request body:
{
"data": {},
"encrypted": false
}
Behavior:
data;configSchema.json;/genkeysGenerates new API keys.
Access:
/getkeysReturns current API keys.
Access:
Response shape:
{
"read": "...",
"write": "...",
"settings": "..."
}
| Method | Path | Purpose |
|---|---|---|
| GET | / |
Home UI. |
| GET | /home |
Home UI. |
| GET | /ui |
Redirects to /ui/home. |
| GET | /ui/{page} |
Registered UI pages. |
| GET | /docs |
Swagger UI. |
| GET | /docs-extra |
Markdown documentation portal. |
| GET | /docs-extra/{doc} |
Render one Markdown document from docs/. |
| GET | /version |
Version information and config schema version. |
| GET | /config |
Config page. |
| GET | /config.html |
Config page alias. |
| GET | /license |
License page. |
| Method | Path | Purpose |
|---|---|---|
| GET | /card/erase |
Erase app-level card data. |
| GET | /card/format |
Complete card format. |
These routes are intended for NFC/contactless card operations and should be used carefully in service contexts.
| Method | Path | Purpose |
|---|---|---|
| GET | /license/interfaces |
Returns valid license interface names. |
| GET | /license/trial/{interface} |
Activates a trial. |
| GET | /license/deactivate/{interface} |
Deactivates a license. |
| GET | /license/status |
Returns license status. |
Valid interface path values:
nfceyecardall/logsDownloads combined log content.
/logsClears logs.