Retail Remote App Key
A key on the till that calls your service. A manifest installs it.
Area: Your app: its install, its user and its doors · Why it is here: contract remote_till_key; guide chapter 06; guide chapter 13; recipe ai_till_key; recipe point_handler · Fields: 16
iVendNext's own description: One till key answered by a partner's own HTTPS service. Only a System Manager keeps these records; a store switches the key on in POS Studio.
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Retail%20Remote%20App%20Key?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one:
curl -s "https://⟨site⟩/api/resource/Retail%20Remote%20App%20Key/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Create one (the required fields first), if your app's role may:
curl -s -X POST "https://⟨site⟩/api/resource/Retail%20Remote%20App%20Key" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"partner_name": …, "app_name": …, "button_key": …, "button_label": …, "endpoint_url": …, "secret": …}'
Change one with PUT /api/resource/Retail%20Remote%20App%20Key/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.
Samples that use it
s1_warranty · s2_bins · s6_ai_till_key · s22_customer_loyalty
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Partner | partner_name |
Autocomplete | yes | |||
| App name | app_name |
Data | yes | |||
| Key | button_key |
Data | yes | |||
| Label on the key | button_label |
Data | yes | |||
| Enabled | enabled |
Check | ||||
| May return a message for the cashier | returns_message |
Check | ||||
| May return sale details (Sale Attributes) | returns_sale_attributes |
Check | ||||
| May return line details (Transaction Item Attributes) | returns_line_attributes |
Check | ||||
| Address | endpoint_url |
Data | yes | |||
| Signing secret | secret |
Password | yes | |||
| Time to answer (seconds) | timeout_seconds |
Float | ||||
| The shop agrees to send these sale details to this address | consent_given |
Check | ||||
| Recorded by | consent_by |
Data | yes | |||
| Recorded on | consent_on |
Datetime | yes | |||
| Address consented to | consent_url |
Data | yes | |||
| Sale details consented to | consent_fields |
Small Text | yes |