In order to use any API commands, at any level, your client must first authenticate and obtain an authentication code.
This authentication code can then be used to make one or more calls to API functions.
See also Authentication.
Create a URL that the user can click on which will automatically log the user into the Web Interface without needing to enter his/her username and password.
Return information that can be used to brand (private label) a user interface consistently with the branding the user would experience when logging in to WebMail.
This function checks if a specific domain name is valid, has good MX records, an supports a sufficiently good level of SMTP TLS
that LuxSci SecureLine can use TLS for secure email delivery.
When composing an email message, you may have a list of recipients and want to know what kind of encryption, if any, would be used for each recipient when it is finally sent out with SecureLine encryption. This function allows you to check this without actually sending a message to these recipients.
Email suppressions that apply to all sending by a specific users.
These also apply to messages sent by Secure Marketing if those messages are sent through the user in question's SMTP account.
The LuxSci Secure Marketing v3 API is a subset of the LuxSci Account API
with commands specifically for the LuxSci Secure Marketing v3 system. Secure
Marketing v3 API commands are “user” scope and provide visibility
into marketing assets owned by or shared with the user used in the API request.
Note, if you are using Secure Marketing v2, then these endpoints do not apply to you.
This report allows you to see how each SMTP message from email programs and devices was sent to each recipient and what the delivery status is for each of these recipients.
This report provides summary statistics on the email delivery status, open status, click status, encryption status, and suppression status of messages
sent or updated in a time interval.
This report allows you to query on the “URL click” events (or lack thereof) for email messages sent via WebMail that have email click tracking enabled.
This report allows you to see what messages that you have sent successfully have been “marked as spam” by recipients and this information has come back to us via one of our feed-back loops.
This report allows you to see all SMTP login failures, as well as sending errors that resulted from our servers explicitly rejecting your request to send an email message for one reason or another.
Return details for a specific asynchronous reporting job.
WebAides
Note that in order to issue API commands that access a particular kind of WebAide (e.g. Calendars), your API Interface must he enabled to access that type of WebAide in the API Interface access control area. E.g., your API Interface could be configured so it can only access Calendars and not Tasks or any of the others. Similarly, it could have only Read access to specific types of WebAides.
Return a list of all WebAides accessible to the specified user, that are also of the indicated type. You can use the query string to add filters to narrow down the results.
Gets a list of entries in a specified Calendar WebAide that fall within a specified range of dates. For recurring entries, the entry will be returned if any of its instances fall within the specified date range.
Get WebAide changes. I.e., all entries that have changed or been added since a particular time. This is ideal for synchronization operations.
User Management
Administrative functions for managing users and user logins. Note that administrators can also employ user-scope user API endpoints to further manage and modify users (e.g., to change a user's password).
Customers with Private Labeling and SecureLine may choose to setup NameSpace(s) to associate with their Private Labeled themes. These NameSpaces segregate the SecureSend users of these themes from the SecureSend users of other themes and of other LuxSci customers. These functions allow you to manage the users in a particular SecureSend NameSpace in your account.
You need your “namespace id” number to use these functions. This can be found in the “SecureSend User NameSpaces” page accessible in your Private Labeling configuration area. These API functions only permit you to manage users in NameSpaces in your account.
Create a URL that the user can click on which will automatically log the user into the SecureSend Interface without needing to enter his/her username and password.
The LuxSci Secure Marketing v2 API is a subset of the LuxSci Account API
with commands specifically for the LuxSci Secure Marketing v2 system. Secure
Marketing v2 API commands are “account” scope. Note, if you are
using Secure Marketing v3, then these endpoints do not apply to you.
The API functions described herein allow your API client to
programmatically access, insert, add, update and delete resources
effectively within LuxSci Secure Marketing platform. This means you can
perform functions programmatically on specific contacts, contact lists,
and statistics automatically from third-party applications or custom code.
Linking the API to your Secure Marketing Login(s)
In order to use the LuxSci Secure Marketing API commands, you need to link
your API configuration to a specific user in the Secure Marketing
interface. The API commands will then operate through that user on that
user’s data and with that user’s level of access to the system.
To do this, you need to make a support ticket in the LuxSci web
interface requesting that this operation be performed for you.
This call permits you to get your contacts’ data from the system by specific list or in aggregate. None of the request body parameters are required, and if you leave them blank, the call will return all contacts’ data from all your lists.
Returns details on the posts currently stored in the database table associated with a specific Secure Form configuration. This function is recommended for use when synchronizing or periodically downloading new rows to an external source: it allows you to quickly and easily see what, if any, entries are new relative to your last actions (if you saved the last index or date when you previously downloaded data).
There are many reports available in the LuxSci user interface. Some
of these are account-wide and some are the same reports, but restricted to
a particular user's activity.
Access to all of these reports is very similar. They all use an HTTP
GET; account-wide reports use account scope; similar user-specific reports
are available under user scope. All reports use the same mechanism for
restricting date ranges and requesting particular "pages" of results. The
following section specifies the usage features common to all of these
report types. The subsequent sections discuss each of the particular
account scope reports available. See the User Reports
section for a list of the respective user-scope reports.
This report provides summary statistics on the email delivery status, open status, click status, encryption status, and suppression status of messages
sent or updated in a time interval.
This report allows to see what messages that you have sent successfully have been "marked as spam" by recipients and this information has come back to us via one of our feedback loops.
This report allows to see all SMTP login failures, as well as sending errors that resulted from our servers explicitly rejecting your request to send an email message for one reason or another.
