This document is valid from ICM 22.214.171.124-LTS and 7.10.38-9-LTS.
For previous versions, refer to Concept - Integration of Progressive Web App and inSPIRED Storefront (valid to 126.96.36.199).
The API token login feature enables customers to log in to both the Progressive Web App (PWA) or any other REST-based clients and the Responsive Starter Store.
This feature can be useful if certain elements of the PWA (e.g., product listing), but also elements of the Responsive Starter Store (e.g., checkout) should be used together in a project.
|ICM||The abbreviation for Intershop Commerce Management|
|PWA||The abbreviation for Progressive Web App|
The API token login can be enabled generally or domain-specifically. Therefore consider the following settings:
In the appserver.properties, the following property must be configured:
intershop.apitoken.cookie.enabled=truehas to be set in the domain-specific configuration of the site.
The PWA must have cookies enabled. If this is the case, a cookie is written when the ICM application server processes a request (page is not cached by the web adapter).
The cookie named
apiToken contains a JSON object with the API token.
'isAnonymous' indicates the authentication state:
'true'for anonymous users
'false'for authenticated users
When the ICM starts handling a request and the cookie is present, the ICM ensures that the user is logged in or an anonymous basket is retrieved.
For technical reasons, ICM overwrites the PWA cookie with its own cookie. The difference is that another JSON attribute is added, which is called
If the user is logged into the ICM but no cookie is available when the ICM takes over, the user will be logged out.
The feature is based on the assumption that PWA and ICM can read and write each other's cookies. That means that both cookies must have the same domain and the same path. Therefore, the feature only works if PWA and ICM are running in the same domain.
When does ICM write the cookie?
When does ICM delete the cookie?
The detailed workflow is as follows:
|intershop.apitoken.cookie.enabled||'true', if the feature should be active, otherwise anything else.|
|intershop.apitoken.cookie.name||If the cookie should not be named '|
|intershop.apitoken.cookie.maxage||The maximum age of the cookie. Since our session is 60 minutes long, the default is 60.|
|intershop.apitoken.cookie.comment||The API allows to set a comment, which can be set here.|
|intershop.apitoken.cookie.sslmode||'true', if the cookie should be SSL-only. The feature will not work if ICM or PWA still use HTTP.|
UserLogin is called. For the login, the start-node
LoginUser is called. For the logout, the start-node
Logout is called.
This pipeline does what is done for login and logout in the platform. In f_business, the pipeline is overwritten to call the pipelines for
If there are additional tasks in customer projects when a user is logged in, further overwriting may be necessary.
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.