Quick Start
Embed an email editor in your app using API keys, user tokens, and an iframe.
This guide walks through the first working ASC Editor Plugin embed flow.
You will create an Application API key, create or refresh an End User token, generate a temporary code, create an email, open the editor, and receive saved content through your Push URL.
Prerequisites
- A backend service that can make outbound HTTPS requests to ASC Editor Plugin APIs.
- An Application in your Platform Console.
- A Push URL endpoint on your backend to receive saved email content.
Base API URL:
https://api.aurorasendcloud.com/editor-plugin/Step 1: Open or create an Application
Go to the ASC Editor Plugin entry page and sign up or log in.
After setup, AuroraSendCloud creates:
- A Platform Console for your team.
- A default Application for your first Plugin setup.
You can create more Applications later for different products, customers, or environments.
Step 2: Create an API key
- Open your Application.
- Go to Editor API.
- Open the API Keys tab.
- Click Create New Key.
- Copy the generated API key and store it securely on your backend.
The API key is shown only once. Do not expose it in frontend code.
Step 3: Configure your Push URL
The Push URL is where ASC Editor Plugin sends saved email content.
- Open your Application.
- Go to Editor API.
- Open the Push URL tab.
- Enter your HTTPS callback endpoint.
- Save the configuration.
Example:
https://api.yourproduct.com/webhooks/asc-editor-saveYour endpoint must return HTTP 200 after it receives and processes the callback.
Step 4: Create or refresh an End User token
From your backend, call the token endpoint for the End User who will open the editor.
curl -X POST https://api.aurorasendcloud.com/editor-plugin/access/token \
-H "Authorization: Basic $(echo -n 'YOUR_APPLICATION_ID:YOUR_API_KEY' | base64)" \
-H "Content-Type: application/json" \
-d '{
"id": "user_12345",
"name": "Jane Doe",
"email": "[email protected]"
}'Response:
{
"data": {
"token": "eyJhbGciOiJIUzI1NiIs...",
"expireTime": "2026-06-09T10:30:00Z",
"userId": "user_12345"
},
"message": "success",
"success": true,
"code": 200
}The token represents one End User in your Application. Store it on your backend and refresh it when it expires.
Step 5: Generate a temporary code
Exchange the End User token for a short-lived code before opening the editor.
curl -X POST https://api.aurorasendcloud.com/editor-plugin/access/code \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
-H "Content-Type: application/json"Response:
{
"data": {
"code": "tmp_a8f3c2d1e4..."
},
"message": "success",
"success": true,
"code": 200
}The temporary code is single-use and expires after 5 minutes.
Step 6: Create an email
Create an email record and use its id when opening the editor.
curl -X POST https://api.aurorasendcloud.com/editor-plugin/access/email \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
-H "Content-Type: application/json" \
-d '{
"name": "Welcome Email",
"subject": "Welcome to our platform"
}'Response:
{
"data": {
"id": "email_7b2a1f9c",
"name": "Welcome Email",
"subject": "Welcome to our platform"
},
"message": "success",
"success": true,
"code": 200
}Step 7: Open the editor
Use the temporary code and email ID to open the editor in an iframe or a new window.
<iframe
src="https://plugin.aurorasendcloud.com/thirdApp?code=tmp_a8f3c2d1e4...&id=email_7b2a1f9c&lang=en_US"
width="100%"
height="700"
frameborder="0"
allow="clipboard-write"
></iframe>Generate a new temporary code every time you open the editor.
Step 8: Receive saved email content
When the End User saves the email, ASC Editor Plugin sends the content to your configured Push URL.
Example decrypted payload:
{
"emailId": "email_7b2a1f9c",
"userId": "user_12345",
"subject": "Welcome to our platform",
"html": "<!DOCTYPE html><html>...</html>",
"json": {
"body": {
"rows": []
}
},
"timestamp": 1780322400
}Your backend should store the returned HTML and JSON, then return HTTP 200.
Updated 6 days ago
