API Requests

Use the following process to request API access for the first time or to request additional API keys. Please note that Kipu API use is a paid service.

The API Management functionality in the EMR allows you to set up manage, and maintain API access. It covers both in-house integrations and trusted third-party vendor connections to ensure secure and controlled interoperability.

Required Permissions: Only Super Admins can access API Management settings and complete the workflows outlined in this article.

Accessing API Management

Before adding or managing API connections, you'll need to access the API Management tool within your Kipu EMR system. This area allows authorized users to configure integration points securely. Please note that APIs incur a related fee. 

1. Log in to your Kipu EMR account.
2. Navigate to the Settings menu.
   
3. Select Integrations.
4. Click on API Management.

Adding New API Access

Kipu EMR allows you to establish new API connections for either internal (in-house) systems or external vendors. This ensures flexibility while maintaining secure control over who can exchange data with your EMR.

When adding new API access, you can choose between In-House Integration and Vendor Integration.

In-House Integration

Use this option when your organization is building an internal tool or service that needs to communicate with the EMR through APIs. These credentials are linked to a designated staff member.

1. From the API Management screen, click New API Access.
2. Complete the form.
   1. Select Internal.
   2. Choose a user from your system to associate with the API keys.
   3. Review and agree to the Terms & Conditions.
   4. Click Save to finalize the setup.

Note: The selected user will be the owner of the API credentials and is responsible for managing the connection. They will receive their credentials via encrypted email. You must still provide them with your App ID.

Vendor Integration

Select this option when a third-party vendor (e.g., a lab, billing provider, or EHR) needs access to your system. Vendor integrations follow a more controlled approval and activation workflow.

1. From the API Management screen, click New API Access.
2. Complete the form:
   1. Select External (Partner/Vendor).
   2. Type the vendor company name. Kipu Partners will be highlighted for easy identification.
      • If your vendor is not listed, select New Vendor and complete the required information.
   3. Review and agree to the Terms & Conditions.
   4. Click Save to proceed.

If You Are Adding a New Vendor: The system will automatically send a Vendor Agreement for review and signature. Once the vendor agrees and the API is marked Active, you may send the App ID to initiate access.

How to Use Your App ID

1. The App ID is displayed in the top-left corner of the API Management screen.
2. Provide this ID to the vendor. They need it to establish their connection to the Kipu EMR.
3. The API connection will remain in Pending status until Kipu activates it, which may take up to 48 hours.

Deactivating API Access

Sometimes it's necessary to disable an integration, whether due to inactivity, a change in vendor, or internal updates. The API Management section makes it easy to revoke access instantly.

1. Navigate to API Management.
2. Locate the integration you wish to deactivate.
3. Click Deactivate.
   
4. Confirm your action.

Important: The selected credentials will be immediately disabled. The vendor or in-house connection will no longer have access to your account.

Support & Additional Requests

Need a hand? Our team is here to help you get connected smoothly.

🔧 API Support: [e-mail]

Questions? Check out our FAQ here.

Please review our API documentation here.