FAQ

Do you need Help? Look for your answers among the Frequently Asked Questions.

General

help What is the Works with Legrand program?
keyboard_arrow_right

Works with Legrand is an open interoperable platform, a strategic part of Eliot, the Legrand innovative program dedicated to promoting the design and deployment of Legrand connected devices. The program allows the Legrand ecosystem to be compatible with major IoT global players. Works with Legrand, thanks to important partnerships, breaks boundaries enabling other companies to connect their devices or services with Legrand products.

help What is the price for using this service?
keyboard_arrow_right

For a standard usage, this service does not cost anything. You just have to create an account, subscribe to the Starter Kit and enjoy!

help Why could I be interested in this program?
keyboard_arrow_right

The program is an open approach to enable innovation for living and working spaces; if you are integrating our solutions or if you want to enable services based on data coming from Legrand devices, this is the right place. Develop your solution and start to be part of our community!

help How can my company become part of Legrand's partners?
keyboard_arrow_right

You can consume Legrand APIs free of charge, after the sign-in, but with some limitations on the number of calls. If you want to become part of our connections or if you need to increase the number of permitted calls, you need to go in the Contact page and send us an email. We will receive your request and we will contact you as soon as possible!

help I've developed a solution. How can I be part of the solution showcase?
keyboard_arrow_right

Thanks to be part of our community! You can share your solution with us using the Contact page and send us an email. Fill in all the request and we will contact you as soon as possible

help How can I access the forum?
keyboard_arrow_right

Your developer account can also be used on the forum. Sign-In and click on "Forum" in the menu. You can manage your personal information in "MY PROFILE" menu. Then, click on the pen icon

help How can I test the APIs?
keyboard_arrow_right

Go on the drop down menu "APIs" and choose "APIs list". Click on the API you want to start your tests.

help What do I need to do to start creating an application ?
keyboard_arrow_right

Go on the drop down menu "APIs" and choose "Subscriptions". For further information, you can consult our tutorials.

Account management

help How can I register an account?
keyboard_arrow_right

In order to access to data concerning the APIs, you need to create an account. Go on the Sign Up page.
If you are a third party developer / partner, you have to click on the Sign Up of "You are developer?" and start filling all the form.

If you are an internal developer, choose the Legrand's Sign in.

help How can I change my credentials?
keyboard_arrow_right
To change your credential (email, First name and Surname, Display name for forum, ...) you first need to Sign In. Go to "MY PROFILE" menu and click on the pen icon.
You will be redirected and asked to sign in one more time.
Finally, change the fields you want and click on "Confirm" button.
Image of the change credential interface
help I've lost my password. What can I do?
keyboard_arrow_right

Go in the Sign In page and click on "Register or Log in". Then, click on "Forgot your password ?" and follow the steps to get a new one

help How can I delete my account?
keyboard_arrow_right
Sign in here with your Works with Legrand credentials. Then, follow the procedure

Troubleshooting

help Is there any test accounts or devices?
keyboard_arrow_right

Unfortunately, there are no test accounts or devices for the moment.

help Can I access data directly from the devices?
keyboard_arrow_right

It is not possible. The only way to access the data and the devices is via the Cloud APIs.

help Why there is a Primary key and a Secondary key in my subscription?
keyboard_arrow_right

Both keys are usable, and only one key is needed at a time. Thanks to these 2 keys, you can change a key without down time of your application. For example, if you want to replace your primary key, the procedure is :

  • Configure your application to use the secondary key;
  • Deploy it to your customers;
  • Regenerate the primary key;
  • (optional) reconfigure your application to use the new primary key
help I am a third-party developer, how can I register a webhook?
keyboard_arrow_right

In order to register a webhook for Home + Control API or Smarther API, follow the specific tutorial on the link

help What are user consents? Can it be revoked?
keyboard_arrow_right

It is mandatory for users to accept the scopes defined in your application in order to use it. Users can revoke the consents they gave on a specific application from a Legrand app. This revokation process must not be implemented by third party applications.

help What happen if the user refuse the consents?
keyboard_arrow_right

The user will have to consent on all the scopes provided during the application registration step. The user has 2 options:

Accept all scopes: in this case, Legrand authentication will resume and redirection to the reply URL will be made
Deny: if the user denies, he will not be connected, so he will have to log in again and consent on the scopes to access the application. Moreover, he will be redirected to the redirect_uri with two parameters in query string :

  • error: access_denied
  • error_description: Access denied by user
help What happens if I change the scopes required in my application?
keyboard_arrow_right

You changed the scopes required by your application and this change has been approved. Then, the authentication will not be allowed as long as the scopes required on the previous refresh_token are different from the scopes currently existing on the application. You will need to ask for a new authentication with the grant_type "authorization_code", so the user can give his consent on the new provided scopes.

help How long a token is valid?
keyboard_arrow_right
  • id_token = 1 hour
  • access_token = 1 hour
  • refresh_token = 90 days
help How can I retrieve my plantId, moduleId and ambientId?
keyboard_arrow_right

To find the plantId

  • Sign up with your Works with Legrand account. You must have subscribed to the Starter Kit
  • Go on the “API” drop down menu, click on “APIS LIST” and choose the Smarther API or Home + Control API
  • On the left, click on “GET Plants” for the Smarther or “GET Get users’ plants” for Home + Control. Then go in the “Try it”
  • In Authorization section, choose “Authorization code” for ELIOT - Azure AD B2C - OpenID Connect for the Smarther or OAuth Server for Try it Eliot API for Home + Control. If you are logged in, other information are already filled up
  • A popup will be opened. Fill the information and validate
  • Click on “Send” button and retrieve the ID of the plant in the Response content

 

To find the moduleId and ambientId

  • Sign up with your Works with Legrand account. You must have subscribed to the Starter Kit
  • Go on the “API” drop down menu, click on “APIS LIST” and choose the Smarther API or Home + Control API
  • On the left, click on “GET Topology” for the Smarther or “GET Get plant’s topology” for Home + Control. Then go in the “Try it”
  • In the Query parameters, fill in the “plantId” field
  • In Authorization section, choose “Authorization code” for ELIOT - Azure AD B2C - OpenID Connect for the Smarther or “Authorization code” for OAuth Server for Try it Eliot API for Home + Control. If you are logged in, other information are already filled up
  • Click on “Send” button and retrieve the IDs of the modules and the ambient (only for Home + Control) in the Response content
help How can I associate my Smarther or C300X13E account to my WWL account?
keyboard_arrow_right
  • First, if you don’t have a Legrand account you need to create one on Works with Legrand and to subscribe to the Starter Kit
  • You must also have downloaded the Thermostat or Door Entry application and to have created an other account (you can use the same Email/Password as previously)
  • On the left side menu, click on “Account” and then on “Third-party access”
  • Sign-in by using your Legrand credentials
  • A message will appear to confirm the connection. You can now use the APIs
  • To use the “Try it”, you need to enter your Legrand credentials
Illustration of linking Legrand's and Smarther's or C300X13E’s accounts
help I didn’t receive my client_secret. What can I do?
keyboard_arrow_right

After validation of your application, you receive the needed client_secret by email. You can check in “MY APPLICATIONS” menu the status of your request. If you can’t find this email in your regular box, please check your spam folder. If you use Gmail, this email can arrive in “Promotions” tab. If you still can’t find this email, please write us a message via the contact form with your Application ID