Skip to main content

​
Eka Connect

1

ONBOARDING

STEP 1: Sign Up for an API KeyTo get started, you need to sign up for an API key. This key will authenticate your requests and give you access to our API. Ping us and we will provide you with the required API Keys.Pre-requisites

Client ID

A unique identifier assigned to a third-party application interacting with Eka’s API.

Client Secret

It is a confidential key, similar to a password used alongside the Client ID.

Obtain the Client ID and Client Secret
  • Login to your Eka Care Control Panel at Console and create client_id and client_secret
  • If you’re building an app for doctors or patients, you can either integrate Eka Accounts using end-to-end OIDC or request an API key from your healthcare provider’s workspace for access. Hub
  • For support or more details, contact us at ekaconnect@eka.care
STEP 2: Set Up Your EnvironmentBefore making API calls, ensure your environment is properly set up. We recommend using the following tools and libraries:
  • HTTP Client: Use tools like Postman, cURL, or any HTTP client library in your preferred programming language.
  • Base URL: All API requests should be directed to https://api.eka.care
2

AUTHENTICATION

Eka Connect’s API authentication securely verifies users and applications, ensuring only authorized access to sensitive healthcare data.How to Authenticate with EKA’s API
  1. Short Lived Token

1. Get Access Token

Authenticate your app using the login API with your Client ID and Client Secret to receive the required access tokens.

2. Use Access Token

Pass the access token in the Authorization header with each API request to confirm your app’s access to Eka services.

3. Handle Token Expiration

Access tokens expire for security reasons and return a 401 Unauthorized error, use the Refresh Token API to generate a new access token.

  • Access Token: A short-lived token (usually 30 minutes) sent with each API request to authorize your app, refreshed using the Refresh Token API.(Access Token API)
  • Refresh Token: A longer-lived token that helps you get a new Access Token when the old one expires, without having to log in again. (Refresh Token API)
  1. Long Lived Token : (Long Lived Token) section.
3

INTEGRATION

We recommend reviewing our products before starting integration and selecting the one that best fits your use case.See you in the (Eka Products) section.