❖ Heads up! This article is intended for Amplify Site Managers.
By the end of this article, you will be able to:
Understand what an API is and when to use it.
Generate and manage API keys and tokens.
Safely delete unused API keys.
🎥 Video Resources
What is an API?
An Application Programming Interface (API) allows two systems—like apps, websites, or databases—to share data seamlessly. It sends and receives information automatically, saving you from doing it manually.
Think of an API as a helpful go-between.
Example: Your great-aunt has the best peanut butter fudge recipe, but she’s in the guest house. Instead of walking over, you send your kid to fetch it.
In this story, your kid = the API—they deliver the request and return the result without either side moving.
When to Use an API
You might use an API if you want to:
Sync user data between systems (e.g., a university database and your Get Connected site).
Automate weekly reports from Get Connected.
Display live volunteer data on an external website.
Once set up, APIs run quietly in the background until you turn them off—no daily management required.
What APIs Can Do
Want to see what’s currently possible with our API? Check out the Get Connected Client API page for a full list of capabilities.
API Keys: Your Digital Doorway
An API key is like a password that lets your program access another system. It identifies who’s making the request and opens the door for data to move.
You can reuse an API key to generate multiple tokens. API keys stay active unless manually deactivated or if the associated user account is deactivated.
Tokens: The Security Pass
To securely share data, your API key generates tokens, which act like temporary permission slips for authenticated access.
Token facts:
Created through tools like Postman.
They expire after one year.
One API key can produce multiple tokens.
How to Create an API Key
Go to Settings > API Keys.
Use the Select a Site Manager dropdown to choose the right site manager.
Click Create API Key.
Copy your new key—Postman will need it for authentication.
Copying an API Key
To copy an existing key:
Go to Settings > API Keys.
Click Copy API Key under the “API Key” column.
Paste it into Postman or wherever you’re authenticating the connection.
Deleting an API Key (Carefully!)
To remove an API key:
Go to Settings > API Keys.
Click the X under the “Options” column for the key you want to delete.
⚠️ Important: Only delete keys not currently in use. Removing an active API key will break any live connections, causing failed calls and error messages.