Generating an API connection to integrate with a supported third-party product is easy!  Follow these steps:

1. Log in to your Aeries website as an admin, in the district’s default school year. API Security can only be managed from the current school year in your default database; in any other year, the page shows a message instead of the certificates. If multi-factor authentication (MFA) is enabled, you may be prompted to verify your identity when you open the page.

2. Navigate to Security -> API Security

3. Select the “Add New Record” button. (If a vendor/product is already selected, the button reads “Add New Vendor/Product.”)

4. Enter the product name and any comment you’d like. Leave Type blank for a standard API certificate. The Type options are only for specific integrations, and some of them (OneRoster, Student App) use a Consumer ID and keys instead of a certificate. See the API Security article for details on each Type.

5. Click Insert to save the Certificate

6. Grant the applicable API Permissions. For each security area, you can set Read, Update, Insert, and Delete (where the area supports them). Each permission can be set to Allow (green) or Deny (red). Field-level Update permissions can also be set in the Field Permissions section. Grant only the permissions the vendor needs. Permission changes may take up to 5 minutes to take effect.

7. Select the checkbox next to “Display Certificate Details”

8. You'll need the certificate, along with your Aeries base URL* to configure the initial vendor connection. 

*The "base URL" is the entire web address of your Aeries system leading up to the part that says "/Login.aspx"

In this example, the highlighted text is the "base URL." Your own base URL will be different.

For hosted customers, your base URL will look like https://yourdistrictname.asp.aeries.net/admin or https://yourdistrictname.aeries.net/admin

(replace "yourdistrictname" with your actual assigned URL address. Use the same address you normally use to log in to Aeries.) Self-hosted districts use their own Aeries web address.