API key for automated sending

An API key lets software send mail from one of your mailboxes without knowing its password. The JPRAXC School ERP uses it to send fee receipts, notices and sign-in codes from your own address, for example office@sunrisepublicschool.example. The key belongs to one mailbox, and every message sent with it goes out from that mailbox and is kept in its Sent folder.

Before you start#

• Decide which mailbox the automated mail should come from. A shared office mailbox is usually best, rather than a person's own mailbox.
• Sign in to the webmail as that mailbox.

Create the key#

1. Open Settings and go to Developer access.
2. Select Generate key.
3. The key is shown once, under Your new API key — copy it now, it is shown only this once. Copy it straight away.
4. Paste it into the School ERP (below), or into a password manager if you will use it later.

The status changes to Active API key.

Use the key in the School ERP#

1. In the School ERP, open General Settings › Email Configuration.
2. Tick Send on Email.
3. In Delivery method, choose JPRAXC Business E-mail API — recommended.
4. Leave JPRAXC Business E-mail API URL as it is, unless JPRAXC support tells you otherwise.
5. Paste the key into API key.
6. Select Save Email configuration.

The Email card then shows Ready, and the Business E-mail plan line shows your storage and plan.

Replace or revoke the key#

• Regenerate key creates a new key. The old one stops working immediately, so paste the new key into the School ERP at once.
• Revoke removes the key. Automated sending with it stops immediately.

Replace the key if you think someone else has seen it, or when a person who knew it leaves.

Good to know#

• Mail sent with the key counts towards your organisation's messages a day.
• The School ERP's saved key is not shown again on its settings page. Leave the box blank when saving other changes to keep the saved key.
• Suspending or deleting the mailbox that owns the key stops automated sending.

Troubleshooting#