Setup CPS Connection
Purpose
Connects the staging terminal to allow live updates on screen.
Example
setup-cps-connection --apiKey {apikey} --serial {serial} --env staging
Command Syntax
| Parameter | Format | Requirement | Usage |
|---|---|---|---|
--apiKey | String | Mandatory | The CPS Key assigned to the Payter terminal. This should be alphanumeric only. |
--serial | String | Mandatory | The serial number of the Apollo family terminal e.g APO20201912345 or POL20195212345. |
--env | String | Mandatory | The Payter environment the terminal is in. This will be staging ONLY. |
caution
The CPS API Key format in other parts of Payter is input as CPS apikey="{apiKey}", for example when Authenticating CPS messages. This extra detail is NOT required for the CLI tool and only the {apiKey} should be used.