Those operations are only necessary for customers that use their own Actility instance. If you are using Kheiron's Actility connectivity, you don't need to proceed.
At the end of 2025, Actility will fully deprecate its DX API. Today, some of the services are already deprecated, which has created a significant number of issues in current applications. Many of you were affected by those, which is the reason why we are raising this communication.
We have implemented the new version of the Actility endpoint, which will resolve all those issues in the next pending release of the platform.
As we will release the update, we recommend that you proceed with some requirements to ensure that the migration will operate smoothly.
Pre-requisites
Create a service account
On the new version of the Actility, you will no longer use a user account. You will instead configure a "service account". To create one, follow these steps:
Access your Actility interface, click on "Administration" and "Service accounts"
A window will open, in the upper right, click on "add service account":
A new form will appear:
Description of the fields:
- Name: name of the service account
- Client ID: unique identifier defined for the service account
- Domain restrictions: restrict the service account to a list of domains.
- Roles: select the roles associated with the service account. Must be Administrator.
Fill in the different fields according to your needs and click on add. If you restrict it to a domain, make sure that your endpoint will be using this domain.
When your service account is created, the Client secret will be displayed (also named Service Account key) :
Warning: the Service account key will not be accessible anymore once it's generated. You need to keep it somewhere on your side.
Verify your domains
To use the new APIs, it is required to have created groups and domains on the Actility backend. To understand better, a group can contain multiple domains.
In the new version of the Actility endpoint, you will be able to create one endpoint for one group. The endpoint can then select multiple domains according to the group configuration.
Example:
IOTHINK SHOWROOM is the group that contains two domains :
- IOTHINK SHOWROOM
- IOTHINK_SHOWROOM
If I use this group in my endpoint, I will need to create a second endpoint for the IOTHINK TRAINING group and domain.
Verify that your old configuration is using those groups and domains. If you don't have any domain applied to your devices, they will not be displayed into your endpoints.
How to migrate
When we release the new version of the Actility code, a new interface will be accessible if the endpoint is on the old version.
A badge "Action Required" (same as Enedis & GRDF) will be available in the interface:
When the customer clicks on this badge, he will be redirected to the interface to enter the Service account ID and Key, as it's shown below:
Once the new credentials information is filled out, you will be able to run the migration process.
At the end of the migration process, the endpoint will be migrated to the new version without any badge visible, and you will be able to continue to use it without any problems.
If an error message is raised when the customer is trying to make the migration, this message can mainly come from Actility's API responding with an invalid code, as we are checking that your credentials are valid. It is possible that you don't understand what is going on in the message. If that happens, don't hesitate to raise a ticket.
Warning: If the endpoint is not migrated, the customer won't be able to list devices on their endpoint or proceed with any other operations (like adding more devices).
Occurring changes on the endpoint itself
- The interface of the endpoint has been reworked and is now simpler. The selection of the type is not needed anymore (Wireless or Enterprise). The custom URL is managed through the custom field in the "Tenant" dropdown.
- The management of the Groups and the Domains is done in two steps. The first step is the configuration of the endpoint, the second step is the configuration of the Groups and the Domains. During the migration of the endpoint, the existing Groups and Domains will be migrated to the new structure. Nothing will change for you unless you had no domains beforehand.
- The URL profile and API don't need to be provided anymore. The services are targeted at the same entry point from Actility, so just a selection of the "location" of the Tenant is enough
All the other items are remaining the same as before. No features have been deprecated on our side for Actility.
Comments
0 comments
Article is closed for comments.