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 stable external userId to POST /access/code and email resource APIs.

Example:

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

The userId must be unique within the Application.

API credentials

API credentials authenticate backend API calls for one Application.

They should be stored only on your backend. Do not expose them in frontend code.

Create API credentials from:

Application -> Editor API -> Application Keys

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

Application access token

An Application access token authorizes backend API calls for one Application. It does not represent or create an End User.

Your backend creates it with HTTP Basic Auth by calling:

POST /access/token

POST /access/token has no request body. Use the returned token as a Bearer token for POST /access/code and /resource/email APIs. Those requests explicitly carry the End User userId.

One-Time code

A one-time 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

One-time codes are safe to pass to the frontend because they expire after 5 minutes, can be consumed only once, and cannot replace API credentials or the Application access token.

Email

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

Your backend creates an Email before opening the editor:

POST /resource/email

The returned email id is a public slug string, such as b7e4a9c2d1f60835. Pass this ID to the editor URL together with the one-time code:

https://abc.editor.aurorasendcloud.com/thirdApp?code=example_code&id=b7e4a9c2d1f60835&lang=en_US

Editor session

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

• A one-time code
• An email ID
• Optional language settings

The editor session belongs to the End User identified by the userId supplied when generating the one-time 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: