Step 1 - API credentials

Pre-requisites

  1. Users requesting access to create API Keys must be assigned an Admin role with permissions to API Key Manager.

Steps

  1. Login to AlumniAdmin
  2. Expand the Site Manager menu and click on the API Access Manager submenu.
1080

Access your portal page as Admin then on the left menu click on "Site Manager > Api Access Manager"

  1. In the API Access Manager page, click the Create Key button.
1072

Click on top right button 'Create Key'

  1. In the Create API Key modal, enter a name for the key then click the Save button.
1068

Type the API Key name.

  1. The API Key Created modal appears which contains the Client ID and Client Secret. Take note of the information and click the Done button when finished. Please note that for security reasons, this modal will only appear once. The Client ID of your key will be available in the Keys table of the API Access Manager page but the Client Secret can no longer be retrieved after the Done button is clicked.
1078

Copy your 'Client ID' and 'Client Secret' and save it somewhere safe. For security reasons, this 'Client Secret 'will be shown only once.

  1. You can create and remove your keys whenever you need. Now you can access the API reference page to start to use our API.

What’s Next

Access the token endpoint to generate your access_token using your newly created credentials.