Skip to main content

Search

Welcome to Support

How to create Amilia API keys for the TeamSideline integration

  • Updated

To connect Amilia to TeamSideline, create a read-only API key named TeamSideline on the API Tokens tab of your Amilia account, copy the key and its secret before you leave the page, and send them to TeamSideline Support through a Secure Inbox link, never by email. Support then connects your Amilia account, and your Amilia programs appear in TeamSideline.

Applies to: Org admins who take registrations in Amilia · Enterprise plan with the Amilia module · Youth, Adult, Youth & Adult and Team Registration programs

Where: In Amilia, the Account section > API Tokens tab; afterward in TeamSideline, Programs > Manage Programs > (program) > 2 Configuration > Amilia Configuration

Create the API key in Amilia

  1. Sign in to Amilia and go to the Account section, then select the API Tokens tab.
  2. Start a new key and name it TeamSideline.
  3. Set the expiration date far in the future, several years out (for example, September 1, 2035). When the key expires, syncing stops.
  4. Set the scope to amilia_api.all.read. TeamSideline only reads from Amilia, so read access is all it needs.
    Amilia's API Tokens tab, where the new key is named and its expiration date and the amilia_api.all.read scope are set
  5. Create the key, then immediately copy the Key and the Secret into a safe place, such as your password manager. Amilia shows the secret only once: if you leave the page before copying it, you can't get it back.
  6. Also copy the address (URL) of this page. It identifies your Amilia organization, which TeamSideline needs along with the key.

The screenshot shows Amilia's API Tokens tab with the key's name, its expiration date and the amilia_api.all.read scope.

Send the key to TeamSideline securely

  1. Email support@teamsideline.com to say your Amilia API key is ready. Don't include the key or the secret.
  2. TeamSideline Support replies with a Secure Inbox link.
  3. Send the key, the secret and the page address through that link only.

What you'll see: once Support has connected your account, an Amilia Configuration button appears under Offerings on the 2 Configuration page of your registration programs. TeamSideline refreshes your Amilia programs and activities once a day, so they can take up to 24 hours to appear there.

If it doesn't work

  • You left the page before copying the secret. Create a new key the same way and delete the one you can't use.
  • There's no Amilia Configuration button on a program's 2 Configuration page. Your account isn't connected yet, your plan doesn't include the Amilia module, or the program's registration type can't be linked (Youth Camp Registration programs can't). Contact TeamSideline Support.
  • Your Amilia programs stop updating, or new registrations stop syncing. The key may have expired or been deleted in Amilia. Create a new key and send it through a Secure Inbox link in the same way.
  • You already emailed the key or put it in a ticket. Tell TeamSideline Support, create a new key in Amilia, send the new one through a Secure Inbox link, and delete the old key in Amilia so it stops working.

Good to know

  • Never send an API key, secret or password by email, chat or in a support ticket. TeamSideline Support never asks for your Amilia password.
  • If your organization has several Amilia branches, create a key in each branch you want to connect and send each one, with its page address. TeamSideline connects each branch separately.
  • Don't delete or let the TeamSideline key expire while you use the integration.
  • Amilia's own screens can change. For help with Amilia itself, contact Amilia.
  • The sync is one-way: TeamSideline copies registrations from Amilia and never changes anything in Amilia.

Related articles