Editor API
Manage API credentials, embed settings, and Push URL delivery for an Application.
The Editor API page manages backend credentials, editor launch methods, and saved-content delivery for one Application.
It contains three tabs:
- API Keys
- Embed
- Push URL
API Keys
API keys authenticate backend API calls for this Application.
Use API keys when your backend calls:
https://api.aurorasendcloud.com/editor-plugin/
Create an API key
- Open the Application.
- Go to Editor API.
- Open the API Keys tab.
- Click Create New Key.
- Enter a key name, such as
Production KeyorStaging Key. - Click Create.
- Copy the generated API key and store it securely.
The API key is shown only once.
Use an API key
Application-level API calls use Basic Auth with the Application ID and API key.
Authorization: Basic base64(YOUR_APPLICATION_ID:YOUR_API_KEY)Example:
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]"
}'Manage API keys
Use the API Keys table to:
- View existing key names.
- Copy a key value if it is still available.
- Edit a key name.
- Delete a key that should no longer be used.
Deleting a key immediately stops API calls that use that key.
Embed
The Embed tab shows the supported ways to open the editor from your product.
Supported methods:
| Method | Description |
|---|---|
| JavaScript | Opens the editor in a new tab or window from a frontend action. |
| HTML Link | Uses a static anchor tag to open the editor. |
| iframe | Embeds the editor inside your product page. |
All methods require:
- An End User token generated by your backend.
- A temporary code generated from that token.
- An email ID.
Example iframe:
<iframe
src="https://plugin.aurorasendcloud.com/thirdApp?code=TEMP_CODE&id=EMAIL_ID&lang=en_US"
width="100%"
height="700"
frameborder="0"
allow="clipboard-write"
></iframe>Generate a new temporary code each time the editor opens.
Return URL
The Return URL controls where users go after leaving the editor.
If you use a new window or link-based flow, set a Return URL that brings users back to the right page in your product.
Example:
https://app.yourproduct.com/templatesPush URL
The Push URL receives saved email content from the editor.
When an End User saves an email, ASC Editor Plugin sends the content to your configured Push URL.
Configure Push URL
- Open the Push URL tab.
- Enter an HTTPS endpoint on your backend.
- Save the configuration.
Example:
https://api.yourproduct.com/webhooks/asc-editor-saveYour endpoint should return HTTP 200 after successful processing.
Push URL requirements
- The URL must use HTTPS.
- The endpoint should be reachable from AuroraSendCloud servers.
- The endpoint should process duplicate callbacks safely.
- The endpoint should return HTTP
200only after the content is accepted.
Security notes
- Store API keys on your backend.
- Do not expose API keys or End User tokens in frontend code.
- Pass only temporary codes to the browser.
- Rotate API keys if they may have been exposed.
- Use different API keys for production and staging environments.
Updated 6 days ago
