ChatGPTClaudePerplexity

For Developers & Agencies

Build on a doctor's live profile data.

A read-only API that lets a consenting, subscribed doctor share their profile and treatment-package data with your own site or app -- kept in sync with HealthMudraa automatically, on infrastructure HealthMudraa never touches.

Read-only

Profile + packages

30 / 60s

Requests per IP

hm_ prefix

256-bit API keys

$0

Cost to integrate

Get started

Three steps to your first call.

  1. 01

    Doctor enables access

    The doctor (or whoever manages their account) calls POST /doctors/api-access/enable from their own session. Requires an active subscription.

  2. 02

    Store the key

    The apiKey is shown once, at creation. There's no plaintext stored anywhere -- if it's lost, regenerate instead of trying to recover it.

  3. 03

    Call the endpoints

    Pass X-Api-Key on every request. Server-side rendering is strongly recommended -- see SEO guidance below.

No dashboard toggle yet. Enabling, rotating, and disabling access is done by calling the endpoints directly, authenticated as the doctor -- there's no visual Settings page for this today. If you're building on behalf of a doctor who isn't comfortable calling an API themselves, have them reach out through Support.

Authenticate every request with the key in a header:

X-Api-Key: hm_K7h9pL2mN5qR8sT3vW6xY0zB4cD7eF1gH2jK5lM8nO

Endpoint reference

Two endpoints. Both read-only.

GET/api/public/v1/doctors/:slug

Doctor profile

Name, specialization, bio, city, qualifications, experience, photo, languages.

Request

curl -H "X-Api-Key: hm_K7h9pL2mN5qR8sT3vW6xY0zB4cD7eF1gH2jK5lM8nO" \
  https://healthmudraa-backend.vercel.app/api/public/v1/doctors/dr-ramesh-kumar

Response

{
  "status": 1,
  "data": {
    "firstname": "Ramesh",
    "lastname": "Kumar",
    "specilization": ["Cardiology"],
    "about": { "short_description": "...", "long_description": "..." },
    "city": "Bangalore",
    "qualifications": [
      { "degree": "MD", "collegeName": "AIIMS Delhi", "location": "Delhi", "fromYear": 2002, "toYear": 2005 }
    ],
    "noofyearsexp": 15,
    "profilepicurl": "https://...",
    "languages": ["English", "Hindi", "Kannada"]
  },
  "attribution": { "text": "Powered by HealthMudraa", "url": "https://healthmudraa.com" }
}
GET/api/public/v1/doctors/:slug/packages

Treatment packages

Only packages the doctor has publicly listed (status: approved, verified, or active).

Request

curl -H "X-Api-Key: hm_K7h9pL2mN5qR8sT3vW6xY0zB4cD7eF1gH2jK5lM8nO" \
  https://healthmudraa-backend.vercel.app/api/public/v1/doctors/dr-ramesh-kumar/packages

Response

{
  "status": 1,
  "data": [
    {
      "package_Name": "Cardiac Checkup",
      "Treatment_Name": "Complete Cardiac Evaluation",
      "Department": "Cardiology",
      "minprice": 2500,
      "maxprice": 4500,
      "packageImages": ["https://...", "https://..."],
      "normalizedUrl": "cardiac-checkup"
    }
  ],
  "attribution": { "text": "Powered by HealthMudraa", "url": "https://healthmudraa.com" }
}

Required, not optional

Render the attribution visibly.

Both endpoints return an attribution object -- "Powered by HealthMudraa" linking to healthmudraa.com. This is a condition of using the data, not a suggestion: a footer link, a line under the profile card, or a sidebar credit all satisfy it.

Rendering

Fetch server-side. Seriously.

Recommended

Server-side rendering

Your server calls the API, builds the HTML, and sends it complete. Crawlers index everything immediately; the API key never reaches the browser.

Not recommended

Client-side fetch

A browser-side fetch puts your API key in page source -- anyone can read it from dev tools. Fine for an internal dashboard; avoid it for anything public or indexed.

Good compromise

Hybrid

Server-render the doctor data for SEO, then layer client-side JavaScript on top only for interactive bits that don't depend on the fetched data (booking forms, filters).

Rate limiting & errors

30 requests per 60-second window, per IP address. Every error response shares one envelope: { "status": 0, "message": "..." }

ScenarioHTTPMessage
Missing or invalid API key403Access denied.
Doctor not found403Access denied.
API access not enabled by the doctor403Access denied.
Doctor's subscription lapsed403Access denied.
Rate limit exceeded429Too many requests. Please try again later.
Server error500Something went wrong.

Questions developers ask

Why is the 403 response identical for every failure?

On purpose -- it stops anyone probing slugs or keys from learning whether a doctor exists, whether they've enabled access, or whether their subscription is active. Missing key, wrong key, disabled access, and a lapsed subscription all return the exact same byte-for-byte response.

How does a doctor get an API key?

The doctor calls POST /doctors/api-access/enable from their own authenticated session. The key is shown once, at creation -- it's never stored in plaintext and can't be recovered later, only rotated.

Is there a dashboard toggle for this yet?

Not shipped yet. Today a doctor (or whoever manages their account) enables, regenerates, or disables access by calling the three /doctors/api-access/* endpoints directly, authenticated as that doctor. A visual Settings page is planned.

What happens if the doctor's subscription lapses?

Every public endpoint call starts returning the same generic 403 immediately. The doctor can still disable access manually even with a lapsed subscription; re-enabling requires an active subscription again.

Can I cache the data instead of calling the API on every page view?

You should. Rate limit is 30 requests/60s per IP. Fetch on a schedule (hourly is a reasonable default) and serve cached data the rest of the time.

This API only returns data a doctor has explicitly opted into sharing.

Nothing private, no financial data, no internal record IDs -- just the profile fields and public treatment packages the doctor has already made visible on their own HealthMudraa page. Questions not covered here? Reach out via Support.