Quick Start
# Step 1: Obtain Server API Keys
After logging into the Simlessly platform with your account, navigate to the Developer module, click on “Using Now” to obtain the server API keys. Please note that only users subscribed to the Pro or Premium plans have the permission to call the OpenAPI interfaces.
# Step 2: Configure Request Header
Construct the request header based on the request parameters defined in Signature of API Reference chapter.
# Step 3: Create Configuration on Platform
Configuration is a Profile configuration template used to generate AC. When generating AC, the configuration name must be included.
# Procedure
# Create configuration on the platform based on use. The configuration cannot be created by OpenAPI.
# After successful creation, call the List Config interface to query all the created configurations.
# Select a configuration for generating AC.
# Step 4: Generate AC
The platform supports single generating AC and batch generating AC. The formats of the generated AC include string, picture, and link.
- In single AC generation, the AC is generated immediately. For the details, refer to Single Generate AC interface.
- In batch AC generation, after calling the Batch Generate AC interface, the platform returns a batch code first, then the user needs to call the List AC Batch Info interface to query the task result. The maximum limit for each batch is 200 ACs.
The generated AC can be directly used by the device for downloading Profile.
# Advanced Abilities
# UPP pattern generates AC
If you want to generate AC through UPP, please select the configuration type as UPP in the above process step 3, and the subsequent steps are as follows:
- Call the Generate UPP interface to generate UPP.
- Call the Download Order interface to download the Profile.
- Call the Confirm Order interface to confirm the Profile installation.
After completing the above steps, you can see a corresponding record in the fleet page (opens new window).
# Notify Profile Status Change
The platform supports sending notifications of Profile status changes to the user’s system address, to integrate the event notifications to your business system, ultimately improving your workflow efficiency.
# Procedure
In the Developer module, enter your notification receiving address in the Webhook URL box, then click Save. Once the status of a profile is changed, a status change notification will be sent to this address. If the user does not configure, no notification will be sent.
Notifications
| Notification | Description |
|---|---|
| DOWNLOADED | The profile has been downloaded. |
| INSTALLED | The profile has been installed. |
| ENABLED | The profile has been enabled. |
| DISABLED | The profile has been disabled. |
| DELETED | The profile has been deleted. |
The parameters of the notifications are detailed in Notify Status Change interface.
# Regenerate AC
General Scenario: Generate AC for a recycled Profile.
Methods: Through ES2+
Calling Cancel Order interface
Scenario
After the subscriber deletes the profile on the device, the profile status will be changed to Available. The user needs to generate a new AC for other devices to download the profile.
Prerequiste
The Profile is in Available or Error status.
Process
Status Flow- After calling the Cancel Order interface, the profile status will be changed to Cancelled.
- After calling the Download Order interface, the profile status will remain unchanged.
- After calling the Confirm Order interface, the profile status will be changed to Available.
Call Expire Order interface
Scenario
Generate new AC in a forced manner for Profiles in Downloaded, Installed, Enabled and Disabled status.
Note
Unless an issue occurs during profile downloading or installation, it is not recommended to recycle the Profile by calling this interface.
Prerequisite
The profile is not in Canceled (status after calling Cancel Order interface ) and Expired status.
Process
