Skip to Content
Version 9.1 by Mark Kohlmann on 2021/07/22 22:48
Hide last authors
Mark Kohlmann 1.4 1 Host processor (LWAPI Server) Setup (DIN-AP3 @ 10.44.5.91):
Mark Kohlmann 1.1 2
Mark Kohlmann 1.4 3 * Enable Authentication [##authentication on##] or SSL [##ssl self##] if not already enabled
Mark Kohlmann 9.1 4 * Enable LWAPI In Config (@ root level):
5 ## "LwApiEnable": true,
6 "LwApiSecurityLevel": "Auth",##
Mark Kohlmann 1.4 7 * Create an API User and record the Key and Secret.  User group must have //LWAPI //role and //Execute //permissions.  //Lightweight API Users// group has been created for this purpose:
8 ##DIN-AP3>sradmin add api user "Central Control" "Lightweight API Users"
Mark Kohlmann 5.1 9 API User Central Control generated with Group permissions Lightweight API Users and Key: (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) Secret: (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
Mark Kohlmann 1.4 10 * If 3-series w/ auth enabled or 4-series with user page auth enabled then add a remote user with permissions to connect to the control system.  This is done by adding a local user to the system with connect privileges.(((
Mark Kohlmann 8.1 11 ##DIN-AP3>adduser -N:(% style="color:purple" %)**lwapi**(%%) -P:(% style="color:darkgoldenrod" %)**dMFN9pJJXjWLGd7t**(%%)
Mark Kohlmann 1.4 12 User account was successfully created.
13 DIN-AP3>addusertogroup -N:lwapi -G:Connects
Mark Kohlmann 8.1 14 'lwapi' was successfully added to group 'Connects'.##
Mark Kohlmann 1.4 15 )))
16
17 Client processor (LWAPI Client) Setup (DIN-AP4):
18
19 * Define remote system in the config:
20 ## {
Mark Kohlmann 7.1 21 "SystemId": (% style="color:darkcyan" %)1(%%),
Mark Kohlmann 1.4 22 "IpAddressOrHostname": "10.44.5.91",
23 "Label": "HUB-1-1",
24 "ConnectionType": "LWAPI"
25 },##
26 * Add remote user for LWAPI (this is the key and secret created on the host):
Mark Kohlmann 5.1 27 ##DIN-AP4>sradmin add remote user HUB-1 (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)
28 Remote User HUB-1 ((% style="color:green" %)//**1a920b8b-3ab8-44bd-bc7b-0fc77abf0a13**//(%%)) added with Group permissions Remote Connection##
Mark Kohlmann 1.4 29 * If 3-series w/ auth enabled or 4-series with user page auth enabled then add a remote user with permissions to connect to the control system.
Mark Kohlmann 6.1 30 ##DIN-AP4>sradmin add remote user HUB-1_CWS (% style="color:purple" %)**lwapi**(%%)** (% style="color:darkgoldenrod" %)dMFN9pJJXjWLGd7t(%%)**
Mark Kohlmann 5.1 31 Remote User HUB-1_CWS ((% style="color:red" %)//**d7c88ecb-7212-4e8b-8749-ddca759c6a62**//(%%)) added with Group permissions Remote Connection##
Mark Kohlmann 1.4 32 * Assign users to the remote connection, System ID in this example is 1.  API user is to authenticate with the API.  CWS user is to authenticate with the Crestron Web Server before authenticating with the ShowRunner REST API:(((
Mark Kohlmann 7.1 33 ##DIN-AP4>sradmin assign remote user API (% style="color:darkcyan" %)**1**(%%) (% style="color:green" %)//**1a920b8b-3ab8-44bd-bc7b-0fc77abf0a13**//(%%)
Mark Kohlmann 1.4 34 User HUB-1 assigned to remote system 1:HUB-1-1 for API Authorization##
35
Mark Kohlmann 6.1 36 If Necessary:
37
Mark Kohlmann 7.1 38 ##DIN-AP4>sradmin assign remote user CWS (% style="color:darkcyan" %)**1**(%%) (% style="color:red" %)//**d7c88ecb-7212-4e8b-8749-ddca759c6a62**//(%%)
Mark Kohlmann 6.1 39 User HUB-1_CWS assigned to remote system 1:HUB-1-1 for API Authorization##
Mark Kohlmann 1.4 40 )))