This family groups a set of actions related with PrestaShop signup and login flows.
These actions require you to have previously installed our PrestaShop module.
Sign up
This action registers the user in your PrestaShop database, with email and password credentials.
Input settings
| Parameter | Description |
|---|---|
| Connection (required) | Paste the base URL from your PrestaShop installation. You will find it in Arengu's plugin, inside the Modules Manager of your PrestaShop account. Paste the API key too. You will find it in Arengu's plugin, inside the Modules Manager of your PrestaShop account. |
| firstname (required) | The user's first name. |
| lastname (required) | The user's last name. |
| Email (required) | The user's email. |
| Password | The user's password. In passwordless flows, this password will be automatically generated. |
| Redirect URI | This is the URI where the user will be redirected after a successful authentication. |
| JWT expiration time | This action will generate a link with a JWT token to allow users to be authenticated in your PrestaShop. You can set a different expiration time if you want to send this link via email as a magic link, for example. |
Output object
| Property | Type | Description |
|---|---|---|
| id | Number | The user ID number in the PrestaShop database. |
| String | The user's email. | |
| firstname | String | The user's first name. |
| lastname | String | The user's last name. |
| birthday | String | Data of birth with yyyy-mm-dd format. |
| id_gender | Number | Gender ID associated with the user. |
| company | String | Name of the company associated with the user. |
| newsletter | Boolean | This property indicates if the user has subscribed to the newsletter:
|
| optin | Boolean | it indicates if the user has accepted to transfer personal data for commercial purposes:
|
| default_group | Number | ID of the primary group the user is associated with. |
| groups | Array | List of IDs of the groups the user is associated with. |
| token | String | JSON Web Token (JWT) that transmits the authentication data of this user from our PrestaShop database, encoded as a JSON object. By default, it is valid for 5 minutes, although this can be modified in the action settings. |
| login_url | String | You should use the login_url property that this action returns, inside the Redirect to URL field of your Submit the form action, in order to redirect the user. |
Output object example
{
"user": {
"id": 1,
"email": "jane.doe@arengu.com",
"firstname": "Jane",
"lastname": "Doe",
"birthday": null,
"id_gender": null,
"company": null,
"newsletter": null,
"optin": null,
"default_group": 3,
"groups": [
3
]
},
"token": "...",
"login_url": "..."
}
Check credentials
Check if provided credentials are valid or not.
Input settings
| Parameter | Description |
|---|---|
| Connection (required) | Paste the base URL from your PrestaShop installation. You will find it in Arengu's plugin, inside the Modules Manager of your PrestaShop account. Paste the API key too. You will find it in Arengu's plugin, inside the Modules Manager of your PrestaShop account. |
| Email (required) | The user's email. |
| Password (required) | The user's password. |
| Redirect URI | This is the URI where user will be redirected after a successful authentication. |
| JWT expiration time | This action will generate a link with a JWT token to allow users to be authenticated in your PrestaShop. You can set a different expiration time if you want to send this link via email as a magic link, for example. |
Output object
| Property | Type | Description |
|---|---|---|
| id | Number | The user ID number in the PrestaShop database. |
| String | The user's email. | |
| firstname | String | The user's first name. |
| lastname | String | The user's last name. |
| birthday | String | Data of birth with yyyy-mm-dd format. |
| id_gender | Number | Gender ID associated with the user. |
| company | String | Name of the company associated with the user. |
| newsletter | Boolean | This property indicates if the user has subscribed to the newsletter:
|
| optin | Boolean | it indicates if the user has accepted to transfer personal data for commercial purposes:
|
| default_group | Number | ID of the primary group the user is associated with. |
| groups | Array | List of IDs of the groups the user is associated with. |
| token | String | JSON Web Token (JWT) that transmits the authentication data of this user from our PrestaShop database, encoded as a JSON object. By default, it is valid for 5 minutes, although this can be modified in the action settings. |
| login_url | String | You should use the login_url property that this action returns, inside the Redirect to URL field of your Submit the form action, in order to redirect the user. |
Output object example
{
"user": {
"id": 1,
"email": "jane.doe@arengu.com",
"firstname": "Jane",
"lastname": "Doe",
"birthday": null,
"id_gender": null,
"company": null,
"newsletter": null,
"optin": null,
"default_group": 3,
"groups": [
3
]
},
"token": "...",
"login_url": "..."
}
Issue a token
Generates a secure token you can use to log your user in without password.
Input settings
| Parameter | Description |
|---|---|
| Connection (required) | Paste the base URL from your PrestaShop installation. You will find it in Arengu's plugin, inside the Modules Manager of your PrestaShop account. Paste the API key too. You will find it in Arengu's plugin, inside the Modules Manager of your PrestaShop account. |
| Email (required) | The user's email. |
| Redirect URI | This is the URI where user will be redirected after a successful authentication. |
| JWT expiration time | This action will generate a link with a JWT token to allow users to be authenticated in your PrestaShop. You can set a different expiration time if you want to send this link via email as a magic link, for example. |
Output object
| Property | Type | Description |
|---|---|---|
| id | Number | The user ID number in the PrestaShop database. |
| String | The user's email. | |
| firstname | String | The user's first name. |
| lastname | String | The user's last name. |
| birthday | String | Data of birth with yyyy-mm-dd format. |
| id_gender | Number | Gender ID associated with the user. |
| company | String | Name of the company associated with the user. |
| newsletter | Boolean | This property indicates if the user has subscribed to the newsletter:
|
| optin | Boolean | it indicates if the user has accepted to transfer personal data for commercial purposes:
|
| default_group | Number | ID of the primary group the user is associated with. |
| groups | Array | List of IDs of the groups the user is associated with. |
| token | String | JSON Web Token (JWT) that transmits the authentication data of this user from our PrestaShop database, encoded as a JSON object. By default, it is valid for 5 minutes, although this can be modified in the action settings. |
| login_url | String | You should use the login_url property that this action returns, inside the Redirect to URL field of your Submit the form action, in order to redirect the user. |
Output object example
{
"user": {
"id": 1,
"email": "jane.doe@arengu.com",
"firstname": "Jane",
"lastname": "Doe",
"birthday": null,
"id_gender": null,
"company": null,
"newsletter": null,
"optin": null,
"default_group": 3,
"groups": [
3
]
},
"token": "...",
"login_url": "..."
}
Look up
Find a specific user using their email.
Input settings
| Parameter | Description |
|---|---|
| Connection (required) | Paste the base URL from your PrestaShop installation. You will find it in Arengu's plugin, inside the Modules Manager of your PrestaShop account. Paste the API key too. You will find it in Arengu's plugin, inside the Modules Manager of your PrestaShop account. |
| Email (required) | The user's email. |
Output object
| Property | Type | Description |
|---|---|---|
| email_exists | Boolean | This property returns true if the email is valid or false if it has been previously registered. |
Output object example
{
"email_exists": true
}
