👉Acting on your account remotely
📖 Definition
The Remote Control API enables you to create credentials with specific rights to let you carry out actions on your account outside of Flagship. This way, you will be able to control your account without having to log in to Flagship.
To access the Remote Control API page, go to Settings > Integration > Remote Control API. It is divided into 2 main sections:
New access configuration
This section enables you to generate new credentials with specific rights. Once your access is generated, you will see a popin displaying a clientId and clientSecret that you must copy and keep safe.
⭐ Good to know
Each clientId and clientSecret is a unique pair. We recommend keeping these credentials safe as you won't be able to retrieve them once you close the pop-in. Make sure you don't communicate them publicly.
If you have lost your credentials or have any doubt about their usage, you can still revoke them and generate new ones.
Generated accesses
This section provides an overview of all previously generated accesses, with their name, creation date, and authorized actions.
For each generated access, you can:
Revoke it, meaning that any service using the credentials won’t work anymore (until you update it with new credentials).
View its details, such as all the authorized rights.
⚙️ Configuration
Generating new credentials
To generate Remote Control API credentials, you must be part of an ENTERPRISE package and be a SUPER ADMIN. From the Remote Control API page, apply the following steps:
Enter a name for your new access.
Select the environment(s) you (Or someone on your team) will be able to act on.
Select the actions you want to authorize for these credentials.
Click Generate.
A pop-in appears: we recommend saving your clientId and clientSecret in a safe place before closing the popin as you won’t be able to retrieve them again.
Searching for existing credentials
If you have many accesses, you may want to see all of them to view the details or revoke a specific access. To do so:
Uncollapse the Generated Access section.
Click Details to see the list of authorized rights for an access OR Click Revoke to remove an access.
🚩 Heads up
If you revoke an access, you won’t be able to retrieve it. You will need to recreate the access and will be provided with a new clientId and clientSecret.
Need additional information?
Submit your request at [email protected]
Always happy to help!
Last updated
Was this helpful?