Embed Overview

ASC Editor Plugin can be opened from your product in two main ways:

Both methods use the same backend API flow and the same Push URL callback flow.

Required backend flow

Before your frontend opens the editor, your backend should:

1. Create or refresh an End User token.
2. Create or identify an email record.
3. Generate a temporary code.
4. Return the temporary code and email ID to your frontend.

Base API URL:

https://api.aurorasendcloud.com/editor-plugin/

Typical flow

1. Your frontend asks your backend to open the editor.
2. Your backend calls POST /access/token.
3. ASC Editor Plugin returns an End User token.
4. Your backend creates or selects an email ID.
5. Your backend calls POST /access/code.
6. ASC Editor Plugin returns a temporary code.
7. Your frontend opens the editor with code + email ID.
8. The End User edits and saves the email.
9. ASC Editor Plugin sends saved content to your Push URL.
10. Your backend stores the returned HTML and JSON.

Create email flow

Use this flow when the End User starts from a new email template.

sequenceDiagram
    autonumber
    participant Frontend as Customer Frontend
    participant Backend as Customer Backend
    participant API as ASC Editor Plugin API
    participant Editor as ASC Editor

    Frontend->>Backend: Request editor for a new email
    Backend->>API: POST /access/token
    API-->>Backend: End User token
    Backend->>API: POST /access/email
    API-->>Backend: Email ID
    Backend->>API: POST /access/code
    API-->>Backend: Temporary code
    Backend-->>Frontend: Editor URL with code and email ID
    Frontend->>Editor: Open /thirdApp?code=...&id=...
    Editor->>Editor: End User edits and saves
    Editor-->>Backend: Push URL callback with saved content
    Backend-->>Frontend: Optional preview or status update

Edit email flow

Use this flow when the End User edits an existing email template.

sequenceDiagram
    autonumber
    participant Frontend as Customer Frontend
    participant Backend as Customer Backend
    participant API as ASC Editor Plugin API
    participant Editor as ASC Editor

    Frontend->>Backend: Request editor for an existing email
    Backend->>API: POST /access/token
    API-->>Backend: End User token
    Backend->>Backend: Select existing email ID
    Backend->>API: POST /access/code
    API-->>Backend: Temporary code
    Backend-->>Frontend: Editor URL with code and email ID
    Frontend->>Editor: Open /thirdApp?code=...&id=...
    Editor->>API: Load email by ID
    API-->>Editor: Email content
    Editor->>Editor: End User edits and saves
    Editor-->>Backend: Push URL callback with updated content
    Backend-->>Frontend: Optional preview or status update

Push URL is required

Configure a Push URL before production use.

The Push URL is how your backend receives saved email content. Without it, your product cannot reliably receive the final HTML and editor JSON after the End User saves.

Configure it from:

Application -> Editor API -> Push URL

Choosing a launch method

Use iframe when:

• Users should stay inside your product page.
• Your UI has enough space for an editor workspace.
• You want the editor to feel like part of your product.

Use new window when:

• You want the simplest frontend implementation.
• The editor should be a separate full-page step.
• Your product layout does not have enough room for an iframe.