PUT /module/{technicalName}/install

Details

Steps

Step Description Expected result
In BO, Go to Advanced Parameters > Authorization Server Authorization Server Page is displayed correctly.
No records found in the table
Click on the button “Add new API access” New API access Page is displayed correctly
Fill the form with following data (Client ID : “Client XYZ”, Client Name: “ClientName ABC”)
Click on “Generate client secret & Save” button
There is 1 application in the list
The message “The API access and Client secret has been generated sucessfully” is displayed
The message “Client secret: " is available
The button Copy put the client secret in the clipboard
Go to modules manager page The page title should contains ‘Module manager’
Set the name of the module “Keycloak connector demo” in the search bar
Click on the search button
The module is not displayed
Request with method POST the endpoint “https://[url of your shop]/admin-dev/index.php/api/module/upload-source” with data The HTTP code is 201.

The response is in JSON.

The return data has multiples keys : “moduleId”, “technicalName”, “moduleVersion”, “installedVersion”, “enabled”, “installed”

The return data keys are consistent relative to these data :

{color:#000000}{{color}
{color:#a31515} “moduleId”{color}{color:#000000}: {color}{color:#0451a5}null{color}{color:#000000},{color}
{color:#a31515} “technicalName”{color}{color:#000000}: {color}{color:#0451a5}“keycloak_connector_demo”{color}{color:#000000},{color}
{color:#a31515} “moduleVersion”{color}{color:#000000}: {color}{color:#0451a5}“1.1.0”{color}{color:#000000},{color}
{color:#a31515} “installedVersion”{color}{color:#000000}: {color}{color:#0451a5}null{color}{color:#000000},{color}
{color:#a31515} “enabled”{color}{color:#000000}: {color}{color:#0451a5}false{color}{color:#000000},{color}
{color:#a31515} “installed”{color}{color:#000000}: {color}{color:#0451a5}false{color}
}
Request with method PUT the endpoint “https://[url of your shop]/admin-dev/index.php/api/module/{technicalName}/install” with data

Where technicalName = keycloak_connector_demo
The HTTP code is 200.

The response is in JSON.

The return data has multiples keys : “moduleId”, “technicalName”, “moduleVersion”, “installedVersion”, “enabled”, “installed”

The return data keys are consistent relative to these data :

{color:#000000}{{color}
{color:#a31515} “moduleId”{color}{color:#000000}: {color}{color:#0451a5}null{color}{color:#000000},{color}
{color:#a31515} “technicalName”{color}{color:#000000}: {color}{color:#0451a5}“keycloak_connector_demo”{color}{color:#000000},{color}
{color:#a31515} “moduleVersion”{color}{color:#000000}: {color}{color:#0451a5}“1.1.0”{color}{color:#000000},{color}
{color:#a31515} “installedVersion”{color}{color:#000000}: {color}{color:#000000}{color:#0451a5}“1.1.0”{color},{color}
{color:#a31515} “enabled”{color}{color:#000000}: {color}{color:#0451a5}true{color}{color:#000000},{color}
{color:#a31515} “installed”{color}{color:#000000}: {color}{color:#0451a5}true{color}
}
Reload the page
Set the name of the module “Keycloak connector demo” in the search bar
Click on the search button
The module is displayed
The module is installed
The module is enabled
Use the module action and uninstall it (with deletion) The successful message is displayed.
In BO, Go to Advanced Parameters > Authorization Server Authorization Server Page is displayed correctly.
1 record found in the table
On the first row, click on the button “Three points” The dropdown is displayed
Click on the Delete Button in the dropdown A modal appeared
Click on the Confirm Button in the modal The message “Successful deletion” is displayed
No records found in the table