Add a new API Access
Description
This page is the one-step funnel to add a new API Access to a PrestaShop shop.
Components description
This section MUST describe each component one by one
A component description
Common components
Description | Value | Error message |
---|---|---|
Mandatory | Yes | - |
Allowed/Forbidden values | Letters, dot (.) and dash (-) characters allowed | |
Default value | Default value | - |
Help text | Help text | - |
Tool tips | Tool tips text | - |
Lower limit | ||
Upper limit | ||
Behavior | This name serves as the API Access' client ID | - |
A Scope selector
Description | Value | Error message |
---|---|---|
Mandatory | Yes | - |
Allowed/Forbidden values | - | |
Default value | - | - |
Help text | Help text | - |
Tool tips | Tool tips text | - |
Lower limit | ||
Upper limit | ||
Behavior | Allows the user to select if the API Access is authorized to one or multiple scope | - |
Behaviors description
Workflow
This page only serves the API Access creation workflow in which the user fills the mandatory fields validating the form.
Behavior description
If the user input an unauthorized character they will get a focus on the name field when trying to validate the form to create the API Access
If the user does'nt input an associated authorized application they will get a focus on the associated application field when trying to validate the form
If the user doesn't input at least a scope they will get a focus on the scope field when trying to validate the form
When the form is validated the user is taken to Authorized application details and a green alert is displayed with the API Access' client secret
Error messages
Limitations
This page only serves the creation of API Access
Last updated