be Smart.
be Secure.
Phone: 800-441-6612

Introducing LuxSci’s new API

LuxSci has just released it a new API for automated access to management of users and accounts.  The new RESTful API has been re-written from the ground up with a focus on security and usefulness.

The old APIs work well, but are based on “old technology” (e.g. SOAP) which was the golden boy for API usage many years ago, but which has since been replaced by RESTful APIs as an industry standard.  We are taking this opportunity to re-tool our APIs using REST and modern API security techniques, and then to expand these APIs to provide more and more integration pathways with LuxSci.

This first release replaces the now-deprecated SOAP-based “User API” and enables the API access to:

  1. Getting and updating user profile contact information
  2. Changing user passwords
  3. Retrieving user preferences
  4. ManagingWebAides (Contacts, Calendars, Tasks, Notes, and Links):
    • Creating and deleting WebAide containers
    • Creating, retrieving, deleting, and updating individual entries
    • Creating, deleting, and updating entries in bulk
    • Retrieving lists of entries
    • Retrieving list of entries that have been added/updated/deleted since your last check (e.g. for writing synchronization programs)

Additionally, access to user-data can be had in either of the following two ways:

  • Using your API codes + the user’s username and password, for when you need to distribute your API codes and want them to be unusable without the addition of a user password.  This is great for App-based access to user data such as calendars.
  • Using just your API codes, for when you will have full control over your API codes and thus can allow them administrative access to all of your users without additional information.  This makes user management very simple.

Flexible Access Control

The new API has many layers of access control to enable you to lock down your API codes to whatever degree is necessary.  Some of these include:

  1. IP Allow lists.  Instead of allowing access from anywhere, you can restrict your API codes to be only accessible from specified IP addresses and ranges.
  2. Opt-in functionality. Only those aspects of the API that you have “opted in” to will be accessible for your API codes.  E.g. you could make APIs that are “read only on Address Books” and no other functionality.  APIs that only allow changing passwords, etc. You control the level of access for your API codes; your API will also not “gain scope” over time through the addition of new API commands unless you opt into their use.
  3. Protected users.  Optionally select user(s) that are exempted from your API’s access.  For example, you may wish to exempt your administrative accounts from API access for security reasons.
  4. Multiple APIs.  You can define multiple sets of “API codes” with differing types of access for different purposes.

How do I use the API?

We have PDF guides for getting started and using all of the functions available in the API.  These can be downloaded by anyone with a regular or trial LuxSci account here:

API v2 Documentation

Whats Next?

In the coming weeks, the new API will be expanded:

  • The old SOAP- and CGI-based account APIs will be deprecated as the functionality for managing users, domains, aliases, and other account features is added in to the new API.
  • Completely newfunctionalitywill be added, such as:;
    • Sending email messages
    • Single sign on
    • Downloading reports
    • and more…

What about the old APIs?  These will still function, so those with existing scripts can continue to use them.  However, we will no longer be supporting the old API and will not be adding any non-security-related updates to it going forward.  We do recommend that folks migrate to the new API.

Do you wish you could do something specific with a LuxSci API?  Let us know!

Leave a Comment

You must be logged in to post a comment.

• Access Anywhere
• Fast and Robust
• Super Secure
• Tons of Features
• Customizable
• Mobile Friendly

Send and receive email from your favorite programs, including:

 Microsoft Outlook
 Mozilla Thunderbird
 Apple Mail
 Windows Mail

... Virtually any program that supports POP, IMAP, or SMTP

Keep your email, contacts, and calendars in sync:

 Apple iPhone and iPad
 Android Devices
 Windows Phone

... Any device with Exchange ActiveSync (EAS) support

Relay your server's mail through LuxSci via smarthost:

• Resolve issues with ISP sending limits and restrictions
• Improve deliverability with better IP reputation and IP masking
• Take advantage of Email Archival and HIPAA Compliance
• Even setup smarthosting from Google Apps!

Free web site hosting with any email account:

• Start with up to 10 web sites and MySQL databases
• DNS services for one domain included
• Tons of features and fully HIPAA capable

LuxSci's focus on security and privacy:

• Read The Case for Email Security
• Read Mitigating Security & Privacy Threats
• Review our Privacy Policy

The most accurate, flexible, and trusted filters in the business:

• Premium protection with Intel Security Saas
• Realtime virus database guards against the latest threats
• Seven-day quarantine lets you put eyes on every filtered email
• Supplement with our Basic Spam Filter for even more features

End-to-end secure email encryption — to anyone, from anyone:

• No setup required — encryption is automatic and easy to use
• Secure outbound email with TLS, PGP, S/MIME, or Escrow
• Free inbound encryption via our SecureSend portal
• Independent of your recipient's level of email security
• Widely compatible and fully HIPAA Compliant

Add an extra layer of security with an SSL Certificate:

• Secure your web site
• Debrand LuxSci WebMail with your own secure domain
• Access secure email services via your own secure domain

Encrypt your service traffic via secure tunnel:

• Add another layer of security to your SSL connections
• WebMail, POP, IMAP, SMTP, web/database access
• SecureForm posts, SecureLine Escrow, SecureSend access
• Restrict your account to VPN access only

Secure long-term message archival:

• Immutable, tamperproof email retention with audit trails
• No system requirements — minimal setup, even less upkeep
• Realtime archival of all inbound and outbound messages
• Works anywhere — even with non-LuxSci email hosting

Free data backups included with all email hosting accounts:

• Automatic backups of all email, WebAides, web/database data
• Seven daily backups and up to four weekly backups
• Unlimited restores included at no additional cost
• Custom backup schedules for dedicated servers

Automate your email management:

• Save messages to specific folders or to LuxSci WebAides
• Advanced text scanning with regular expressions
• Tag messages, alter subject lines, or add custom headers
• Filter by message charset, type, TLS status, DKIM status
• Chain filters together for even more complex actions

• Bulk add and edit users, aliases and more
• Control sharing and access globally or on a granular level
• Delegate user roles through permissions
• Configure account-wide taglines, sending restrictions, and more
• Remotely administer account via SOAP API

Share, collaborate, organize, synchronize:

• Calendars, Contacts, Documents, Notes, Widgets, Workspaces
• Fine-grained access control and security
• Access anywhere via secure web portal or smartphone
• Save over solutions like Microsoft Exchange

Free folder sharing for all email hosting accounts:

• Share mail folders with other users in your account
• Subscribe to only the folders you want to see
• Set read-only or read-write access control
• View all personal and shared folders via unified web interface

Color code and label your email messages:

• Define and assign multiple IMAP keywords to each message
• Filter, search, and sort by tags
• Compatible and synchronizes with any IMAP email client
• Also usable with WebAide entries