PrestaShop

These PrestaShop native actions allow integrating your Arengu forms for customer sign ups and login flows.

Connect your PrestaShop account

To connect your PrestaShop account to Arengu you will need the API URL and API key, which can be found by installing the Arengu Auth Prestashop's module:

Sign up

Creates a new user with email and password credentials.

Input settings

Parameter	Description
ID (required)	Action ID. It is used to reference the output values of the action.
Alias	Short description to be displayed in the action.
Connection (required)	Select an existing connection from the vault or create a connection with the API URL and API key found in the Arengu's plugin inside the PrestaShop's Modules Manager.
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.
email	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: `true`: If the user has chosen to subscribe. `false`: If the user doesn't want to receive it. `null`: If the user has not been asked.
optin	Boolean	it indicates if the user has accepted to transfer personal data for commercial purposes: `true`: If the user has accepted. `false`: If the user has not accepted. `null`: If the user has not been asked.
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": "..."
}

Find expected response and extra API information at PrestaShop's documentation.

Check credentials

Check if provided credentials are valid or not.

Input settings

Parameter	Description
ID (required)	Action ID. It is used to reference the output values of the action.
Alias	Short description to be displayed in the action.
Connection (required)	Select an existing connection from the vault or create a connection with the API URL and API key found in the Arengu's plugin inside the PrestaShop's Modules Manager.
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.
email	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: `true`: If the user has chosen to subscribe. `false`: If the user doesn't want to receive it. `null`: If the user has not been asked.
optin	Boolean	it indicates if the user has accepted to transfer personal data for commercial purposes: `true`: If the user has accepted. `false`: If the user has not accepted. `null`: If the user has not been asked.
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": "..."
}

Find expected response and extra API information at PrestaShop's documentation.

Issue a token

Generates a secure token you can use to log your user in without password.

Input settings

Parameter	Description
ID (required)	Action ID. It is used to reference the output values of the action.
Alias	Short description to be displayed in the action.
Connection (required)	Select an existing connection from the vault or create a connection with the API URL and API key found in the Arengu's plugin inside the PrestaShop's Modules Manager.
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.
email	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: `true`: If the user has chosen to subscribe. `false`: If the user doesn't want to receive it. `null`: If the user has not been asked.
optin	Boolean	it indicates if the user has accepted to transfer personal data for commercial purposes: `true`: If the user has accepted. `false`: If the user has not accepted. `null`: If the user has not been asked.
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": "..."
}

Find expected response and extra API information at PrestaShop's documentation.

Look up

Looks up details of an existing user.

Input settings

Parameter	Description
ID (required)	Action ID. It is used to reference the output values of the action.
Alias	Short description to be displayed in the action.
Connection (required)	Select an existing connection from the vault or create a connection with the API URL and API key found in the Arengu's plugin inside the PrestaShop's Modules Manager.
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
}

Find expected response and extra API information at PrestaShop's documentation.



Table of contents

PrestaShop guides & tutorials

Discover our step-by-step guides and tutorials to learn using Arengu with PrestaShop.

Scenarios

Custom signup forms with PrestaShop

Easily create registration forms, login forms or even passwordless forms without coding and embed them in your PrestaShop site.