Webservice
Webservice is the page of webservice keys list and webservice configuration block.
QA
Common components
Search input (todo link)
Bell icon (todo link)
Trophy icon (todo link)
The UI elements
Add new webservice key button
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | - | - |
Default value | - | - |
Help text | - | - |
Tool tips | Add new webservice key | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Enable PrestaShop's webservice toggle switch
| Description | Value | Error message |
|---|---|---|
Mandatory | YES | - |
Allowed/Forbidden values | - | - |
Default value | NO | - |
Help text | Before activating the webservice, you must be sure to:
| - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Enable CGI mode for PHP toggle switch
| Description | Value | Error message |
|---|---|---|
Mandatory | YES | - |
Allowed/Forbidden values | - | - |
Default value | NO | - |
Help text | Before choosing "Yes", check that PHP is not configured as an Apache module on your server. | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Search key input
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | - | - |
Default value | - | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Search description input
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | - | - |
Default value | - | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Search button
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | - | - |
Default value | - | - |
Help text | - | - |
Tool tips | Search | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Enabled toggle switch
| Description | Value | Error message |
|---|---|---|
Mandatory | YES | - |
Allowed/Forbidden values | - | - |
Default value | YES | - |
Help text | - | - |
Tool tips | - | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Edit icon
| Description | Value | Error message |
|---|---|---|
Mandatory | NO | - |
Allowed/Forbidden values | - | - |
Default value | - | - |
Help text | - | - |
Tool tips | Edit | - |
Lower limit | - | - |
Upper limit | - | - |
Behavior | - |
Behaviors description
Add new webservice key button behavior
Add new webservice key is CTA button (Buttons with icons UI kit) it opens Webservice Accounts page.
Alert message behavior
On the top of page there is alert message (Alerts basics UI kit) and it is: It is preferable to use SSL (https:) for webservice calls, as it avoids the "man in the middle" type security issues.
Enable PrestaShops's webservice toggle switch behavior
This is mandatory on-off toggle switch (Forms switch story UI kit) in Configuration block.
Enable CGI mode for PHP toggle switch bahavior
This is mandatory on-off toggle switch (Forms switch story UI kit) in Configuration block.
Webservice listing behavior
Webservice block shows the list of created web. Next to the heading of block, there are a number of webservice keys in the list. Webservice list is shown when some Keys are created. There are Top block and Content block of list elements.
Webservice keys sorting by Key behavior
Once clicked arrow down next to Key title, sorts keys by alphabet from A to Z and keys that start by number in the end. When clicked arrow up - sorts keys from number and then from Z to A.
Webservice keys sorting by Enabled Behavior
Once clicked arrow up sorts enabled keys on top. When clicked arrow down - sort disabled keys on top.
Search key input behavior
This input field (Forms normal Ui kit) with place holder and it is: Search key.
Search description input behavior
This input field (Forms normal Ui kit) with place holder and it is: Search description.
Enabled dropdown behavior
This is dropdown (Dropdowns basics UI kit) to filter disabled and enabled keys. By default dropdown is empty and all keys are shown in list.
Search button behavior
Once clicked Search CTA button with icon (Buttons with icons UI kit) filters webservice keys by entries in Key, Key description inputs and Enabled dropdown. When hover mouse pointer on it, button color changes.
Enabled toggle switch
This toggle switch (Forms switch story UI kit) is is every key row. It enables or disables this particular webservice key.
Edit icon behavior
Once clicked this icon opens this particular webservice page to make some changes.
Three-dot menu icon
Once clicked it opens popup with Delete option. When clicked on Delete, deletes the webservice.
Checkbox behavior
Checkbox on top of list (Forms Stylised checkboxes UI kit) when marked, mark all webservice keys. When unmarked, unmark all webservice keys. By default this checkbox is unmarked. There are checkboxes in each webservice key row. By default all these checkboxes are unmarked. When checkboxes marked allows actions of bulk action dropdown (Dropdowns basics UI kit). There are these options:
Enable selection - enable marked webservices.
Disable selection - disable marked webservices.
Delete selected - deletes marked webservices form the list.
Key column behavior
This column shows webservice key name of 32 symbols.
Key description column behavior
This column shows key description.
Multistores behavior
This page is Multistores dependent page
Last updated
