API tokens allow access to patient data within Pulsara via the Pulsara Public API. The Pulsara Public API is used by 3rd party applications to exchange data with Pulsara. When used correctly, an API token may be used to “unlock” an organization’s patient data for another application to utilize, or it may allow another application to make additions to the Pulsara Patient Channel.
Hospital and EMS Agency admins will have full discretion over the creation, deletion, storage, and distribution of these Pulsara Public API tokens. Because these tokens grant access to patient data, it is very important to keep them in a secure location. For example, an API token should never be sent via email or a text message. A recommended best practice would be to use a password/secrets manager where the token can be shared via a link to a secure item.
Why Use our API?
Integrating with the Pulsara API can:
- Reduce/eliminate double-data entry
- Provide a smoother transition of patient cases between teams
- Provide a better picture of the patient’s journey
Getting Started
An admin at your facility will need to enable the permission for each admin user who needs to generate API tokens.
Navigate to Manage Users from the main menu, locate the desired admin user, and click the pencil button to edit their account.
Scroll down to the bottom of the page and change the Can Manage Keys permission to Yes, then click on the Update Details button to finalize the change.
How to Generate an API token
From the MANAGER main menu, choose API Tokens.
Click on the + API Token button.
Enter a name for the API Token and click Save.
Use the copy button to copy your new API token to the clipboard.
After generating an API token, it’s accessible only once and should be securely stored immediately. After leaving the generation page, the token cannot be accessed again.
If you forget to copy or lose the API token, you’ll need to generate a new one.
Sharing API tokens Securely
It is crucial that API tokens be shared confidentially as they provide access to your data. To ensure that the API tokens are protected, use encrypted methods when sharing them. Examples of encrypted methods include encrypted email and password management tools with sharing capabilities.
IMPORTANT: Normal email is not encrypted and is not a secure method of delivery for API tokens. Pulsara recommends consulting your local IT/Security team for proper ways in which to share these tokens.
Managing Existing API Tokens
Created API tokens will be listed. Use the gray button to View an Activity log, or use the orange X button to Revoke this Token.
