NNarya Developers
API referenceParameter documents

Download a parameter document

GET
/device/v1/parameters/{application_id}

Returns one application's parameter document for this terminal. Call it when the digest in the parameters list differs from the digest of the document the terminal has applied.

The document returned can be newer than the digest in the list. Apply the document you receive, and report its digest in the next heartbeat's parameter_state.

If the request fails, keep the values the terminal already has.

Authorization

DeviceAuth
headerAuthorizationBearer <dvc_<prefix>_<secret>>

The terminal's device token, returned once by POST /device/v1/activations. Send it as Authorization: Bearer <token> on every request except activation.

Path Parameters

application_id*string

The application_id from the parameters list.

Formatuuid

Response Body

The parameter document.

application/json
  1. response

One application's parameter document for this terminal.

application_id*string

The application the document configures.

Formatuuid
schema_revision*integer

The revision of the application's parameter schema that values follows.

Range1 <= value
digest*string

Identifies exactly this document. After applying values, report this digest in the next heartbeat's parameter_state.

Match^sha256:[0-9a-f]{64}$
values*

The configuration to apply: the application's default values with any values set for this terminal applied over them. It can include secrets such as host credentials, so keep it in secure storage and never log it.

Example Request
curl -X GET 'https://device-narya-staging.pmadvisors.my/device/v1/parameters/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",  "schema_revision": 1,  "digest": "string",  "values": {}}