Important: Since CloudBlue version 21.18, session management API is disabled by default and will become end of life in one of the future versions. This is done for security reasons and we strongly recommend updating your integrations a more reliable authentication method, such as, using IDP tokens, SAML-based single sign-on, or shared secret.
This section describes the methods which allow an external system to manage a session in CloudBlue Commerce. There are the following methods:
- Login: This method creates a session.
- Touch: This method prolongs a session.
- Logout: This method destroys a session.
All described methods are available through the HTTPS protocols as GET and POST requests. The URL for executing methods can look as follows:
https://BRAND_ACCESS_URL/servlet/Sessions
where the BRAND_ACCESS_URL parameter is the URL for accessing a brand, for example, cp.brand01.acom. Therefore, the complete URL for executing methods is https://cp.brand01.acom/servlet/Sessions in the example above.
Note: The URL for executing methods contains the PARAMETERS suffix if the GET method is used for HTTP requests. The PARAMETERS is a list of input parameters in parameter_name=parameter_value form.
The Using an Existing Session section describes how to use the existing session for logging in to the CloudBlue Commerce control panel.