❖ Heads up! This article is intended for Center Site Managers.
An Application Programming Interface (API) is software that allows different programs—like apps, websites, or databases—to talk to each other. It sends and receives data on behalf of those systems, making processes faster and more efficient.
Imagine your great-aunt is in the guest house and you want her peanut butter fudge recipe. She's busy, so you send your kid to get it. Your child fetches the recipe and brings it back—you never had to move.
In this case, your child = the API. They deliver the request and response, letting both sides stay put.
When to Use an API
An API connects your Get Connected site to other systems by automating data exchange. You might use one if:
You need to sync user accounts between databases (e.g., a university and a medical center).
You want a weekly report from Get Connected emailed to you automatically.
You’re building an external website and want to display live data from your Get Connected site.
Once an API is set up, it runs in the background until you turn it off—no need for constant hands-on involvement.
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.
Watch & Learn
Need a walkthrough? Check out this quick video to learn how to manage and authenticate your APIs step-by-step: