Add new webservice key
This page opens when in Webservice page clicked Add new webservice key button. It is form for creating new webservice key. Each key gives access only to certain selected resources of the store.
QA
Common components
Save button - Buttons basics UI kit.
Cancel button - Buttons outline UI kit.
Key input
| Description | Value | Error message |
|---|---|---|
Mandatory | YES | The Zip/Postal code is invalid. It must be typed as follows: |
Allowed/Forbidden values | Key input allows entering letters, numbers and symbols (@? # - _). | Only non-accented characters, numbers, and the following special characters are allowed: @? # - |
Default value | Empty | - |
Help text | Webservice account key. The key must be 32 characters long. | - |
Tool tips | - | - |
Lower limit | Key input should be 32 characters long. If it is too short a message appears: | Key length must be 32 characters long. |
Upper limit | Key input should be 32 characters long. If it is too long, a message appears: | Key length must be 32 characters long. |
Behavior | - |
Key description input
It is input with bottom helper (Forms helper UI kit). Helpers text is: The Key description input allows you to add details about the Webservice key. Helpers text is: Quick description of the key: who it is for, what permissions it has, etc.
Enable webservice key toggle switch
It is on-off toggle switch (Forms switch story UI kit) that enables or disables this newly created webservice key.
Permissions
This block has an alert message (Alerts basics UI kit) and it is: Set the resource permissions for this key:
Under this message there is the table to set permissions.
| Resource | All | View (GET) | Modify (PUT) | Add (POST) | Delete (DELETE) | Fast view (HEAD) |
|---|---|---|---|---|---|---|
addresses | ||||||
attachments | ||||||
carriers | ||||||
cart_rules | ||||||
carts | ||||||
categories | ||||||
combinations | ||||||
configurations | ||||||
contacts | ||||||
content_management_system | ||||||
countries | ||||||
currencies | ||||||
customer_messages | ||||||
customer_threads | ||||||
customers | ||||||
customizations | ||||||
deliveries | ||||||
employees | ||||||
groups | ||||||
guests | ||||||
image_types | ||||||
images | ||||||
languages | ||||||
manufacturers | ||||||
messages | ||||||
order_carriers | ||||||
order_cart_rules | ||||||
order_details | ||||||
order_histories | ||||||
order_invoices | ||||||
order_payments | ||||||
order_slip | ||||||
order_states | ||||||
orders | ||||||
price_ranges | ||||||
product_customization_fields | ||||||
product_feature_values | ||||||
product_features | ||||||
product_option_values | ||||||
product_options | ||||||
product_suppliers | ||||||
products | ||||||
search | ||||||
shop_groups | ||||||
shop_urls | ||||||
shops | ||||||
specific_price_rules | ||||||
specific_prices | ||||||
states | ||||||
stock_availables | ||||||
stock_movement_reasons | ||||||
stock_movements | ||||||
stocks | ||||||
stores | ||||||
suppliers | ||||||
supply_order_details | ||||||
supply_order_histories | ||||||
supply_order_receipt_histories | ||||||
supply_order_states | ||||||
supply_orders | ||||||
tags | ||||||
tax_rule_groups | ||||||
tax_rules | ||||||
taxes | ||||||
translated_configurations | ||||||
warehouse_product_locations | ||||||
warehouses | ||||||
weight_ranges | ||||||
zones |
Resource column - There are resources listed by alphabet from A to Z.
All - When the checkbox All is clicked, all the checkboxes for the resource are checked or unchecked.
View (GET) - once clicked this link on top of table, all the resources are checked or unchecked for View column.
Modify (PUT) - once clicked this link on top of table, all the resources are checked or unchecked for Modify column.
Add (POST) - once clicked this link on top of table, all the resources are checked or unchecked for Add column.
Patch (PATCH) - once clicked, all the resources are checked for Patch column
Delete (DELETE) - once clicked this link on top of table, all the resources are checked or unchecked for Delete column.
Fast view (HEAD) - once clicked this link on top of table, all the resources are checked or unchecked for Fast view (Head) column.
Scroll bar - there is a vertical scroll bar that helps to scroll the table up and down.
Behavior desciption
Webservice key saving
Once clicked Save button in Add new webservice key page, if it is successful, opens Webservice page with newly created webservice key in the list and alert message (Alerts basics UI kit): Successful creation.
Key
The Generate button (Buttons outline UI kit) is on the right side of the Key input, it generates automatically the webservice key.
Multistores behavior
This page is Multistores dependent page.
Last updated
