Core Concepts

Account

An Account is the login identity for a person on your team.

One email address maps to one Account. The same Account can be used across AuroraSendCloud products if the user has access.

Accounts are used for Platform Console access only. They are not the same as End Users.

Platform Console

A Platform Console is the organization-level workspace for your Plugin team.

It contains:

Applications
Teammates
Console settings
Account access and invite flows

Owners and Admins manage Console-level settings. Teammates can access only the Applications assigned to them, depending on your role configuration.

Application

An Application is the core configuration unit of ASC Editor Plugin.

Each Application has its own:

Application ID
API keys
Embed settings
Push URL
Appearance settings
Domain settings
Editor controls
End Users
Credits and usage

Use separate Applications when you need separate environments, products, customers, brands, or usage pools.

End User

An End User is a user from your own product.

End Users do not log in to AuroraSendCloud. Your backend maps them into an Application by passing your own external user identifier when creating or refreshing an End User token.

Example:

{
  "id": "user_12345",
  "name": "Jane Doe",
  "email": "[email protected]"
}

The id must be unique within the Application.

Application API key

An API key authenticates backend API calls for one Application.

Create API keys from:

Application -> Editor API -> API Keys

Store API keys on your backend. Never expose them in frontend code.

End User token

An End User token represents one End User inside one Application.

Your backend creates or refreshes the token by calling:

POST /access/token

Use the token as a Bearer token for End User-scoped operations, such as generating a temporary code or creating an email.

Temporary code

A temporary code is a short-lived, single-use code used to open the editor from the browser.

Your backend generates it by calling:

POST /access/code

Temporary codes are safe to pass to the frontend because they expire quickly and cannot replace the Application API key or End User token.

Email

An Email is the content record opened and edited in ASC Editor Plugin.

Your backend creates an Email before opening the editor:

POST /access/email

The returned email id is passed to the editor URL together with the temporary code.

Editor session

An editor session starts when your frontend opens the editor with:

A temporary code
An email ID
Optional language settings

The editor session belongs to the End User represented by the token that generated the temporary code.

Push URL

The Push URL is your backend endpoint for receiving saved email content.

When an End User saves an email, ASC Editor Plugin sends the content to your configured Push URL.

Configure it from:

Application -> Editor API -> Push URL

Your Push URL should use HTTPS and return HTTP 200 after successful processing.

Credits

Credits control paid usage, such as AI features and Inbox Preview.

Credits belong to an Application and can be allocated to End Users. Usage and billing should be viewed at the Application and End User level.

Use these terms consistently:

Concept	Use
Application credit pool	Credits available in one Application.
End User credits	Credits assigned to one End User.
End User consumption	Credits consumed by one End User.
Application usage	Usage aggregated under one Application.

Base API URL

All API examples use this base URL:

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