Web Service API - Registration and Access Management
The Request<T> class has a "Ticket" property. This is used to pass the authentication to the web service.
To get a new ticket, the Login Method is called. The user name and password are passed to this method. If the login to c-entron was successful, a ticket (a randomly generated character string) is returned. This character string tells the c-entron web service which user is involved.
https://server.de/CentronService/REST/Login { "Ticket": "", "TrimResponse": 0, "Data": { "AppVersion": "1.0.0.0", "Application": "{8A9E6F82-4DFF-4C93-916C-CEA90EE4ED22}", "Device": "OfficeClient1", "LoginKind": 0, "Password": "Pa$$word!", "Username": "CentronUser" }}
Methods for registration/access management
Method | Description |
Login | This is the most important method in the web service. Users log in to the web service using this method. |
Logout | This method allows you to log a user out of the web service (via the ticket). |
IsValidTicket | This method checks whether the ticket is still valid. |
CheckConnection | This method simply returns the value True. This can be used to check whether a connection to the web service can be established. |
IsWebAccountAuthentication | This method allows you to check whether the ticket is a "web account" (customer access). |
GetAllConnectionTickets | You can use this method to read all logged-in users. |
RemoveConnectionTicket | You can use this method to log users out of the web service. |
GetWebServiceSettings | This method returns special web service-related settings. |
SetWebServiceSettings | This method saves the special web service-related settings. |
GetCommonLoginInformation | This method returns general information about the logged-in user, including their rights in the system. |
IsUserAdmin | Indicates whether the logged-in user is an administrator. |