Client Connection
- Last UpdatedSep 21, 2017
- 2 minute read
This class is used to create a connection to the Recipe Manager Plus Web API. The following constructors are used in the Recipe Manager Plus Client API.
System User Connection
This constructor will create a connection to the Recipe Manager Plus server as a System User. This user only has privileges to access functions in the RuntimeAPI.
ClientConnection(string rmpHostName)
-
rmpHostName – The name of the machine that hosts the Recipe Manager Plus server.
UserToken Connection
This constructor will pass the user Token obtained from ArchestrA Identity Manager by InTouch View Client or any other application using ArchestrA Identity Manager.
ClientConnection(string rmpHostName, string userToken)
-
rmpHostName – The name of the machine that hosts the Recipe Manager Plus server.
-
UserToken – ArchestrA Identity Manager user accessToken in string format.
Operator/Normal User Connection
Creates a connection using the provided username and password. This type of connection will consume a connection license when used. The permission configured in Recipe Manager Plus for the passed in user will determine what API calls can be made.
ClientConnection(string rmpHostName, string UserName, string Password)
Any application that uses Client API and runs as an Administrator uses this constructor, auto-registration will happen with ArchestrA Identity Manager using the user credentials. If the auto-registration or the SSL certificate adding to trusted store fails, the user has to install and configure the Recipe Manager Plus Client Connection Configuration feature.
This feature will add the SSL certificates from ArchestrA Identity Manager node to trusted store and register the Recipe Manager Plus clients such as Client API with ArchestrA Identity Manager.
Client secret (a GUID) is created and stored in ArchestrA Identity Manager and ArchestrA Data Store.
The admin user running the configurator and the application using RMPClientAPI will be added automatically to the list of whitelisted users/groups to access the client secrets.
You can add more users/groups who will be running the applications such as IDE, or applications involving Client API and Rest API. You must install and configure Recipe Manager Plus Client Connection Configuration feature to whitelist users/groups. For more information, refer to the Recipe Manager Plus Install Guide.