API user and authentication

Permission to use the Maxemail API is granted as a role on a Maxemail user account. The user account must be created specifically for API access, separate from any user accounts for staff accessing the Maxemail interface. As with regular user accounts, it is recommended to limit the permission roles to the minimum required, but also set IP restriction to limit access to the servers running the API tasks.

User account

Once a new user has been created, contact the Support Team to request the API role to be added. For security, the API role cannot be set with any administrative roles.

The password for the user account must be set by an administrator using the User administration interface.

Authentication

API credentials are sent as part of each API request, as a Basic Auth header. See the API communication specification for more details.