API Reference

Sandicare
Integration API

Programmatic access to Sandicare's teleconsult platform. Enroll patients into waiting rooms and redirect to specialized health services.

Authentication

Include your API key in the x-api-key header on every request. Your key and programId are issued by Sandicare when you set up an integration.

x-api-key: prd_xxxxxxxxxxxxxxxxxxxxxxxx
Sandbox
sdx_…
Development & testing
Production
prd_…
Live patient data

Environments

EnvironmentBase URLKey prefix
Productionintegrations.sandicare.mx/api/v1prd_
Sandboxintegrations-sandbox.sandicare.mx/api/v1sdx_

Errors

StatusDescription
200OK
Request succeeded. Returns a redirect URL.
400Bad Request
Missing or invalid fields. Check types and validation constraints.
401Unauthorized
Missing, invalid, or insufficient API key permissions.
404Not Found
Program, patient, active subscription, or service config not found.
503Unavailable
One of our services failed. Try again later or contact support if the issue persists.
Endpoints
POST
/meetings/enroll

Enroll a patient into a teleconsultation. Returns a URL to redirect the patient to — a Nimbo waiting room for general_medicine, or a pre-configured link for all other services.

Environment
integrations.sandicare.mx/api/v1

Request body

programIdstringrequired

Numeric string ID of the program. Provided by Sandicare alongside your API key.

serviceenumrequired

The teleconsult service type.

general_medicinenutritionpsychologyinternal_medicine
emailstringrequired

Patient's registered email address.

dateOfBirthstringrequired

Date of birth in YYYY-MM-DD format. Verifies subscription ownership.

consultationReasonstring

Required only when service is general_medicine. Brief reason for consulting.

Response

urlstring

URL for the patient.

Flow

01

Program validation

Verifies that the program exists and belongs to the API key's tenant.

02

Patient lookup

Finds the patient in our system by email.

03

Subscription check

Confirms an active subscription exists matching program, email, and date of birth.

04

URL generation

The service responds with a URL to redirect the patient to. For general_medicine, a Nimbo waiting room is created on demand.

curl
curl -X POST \
  https://integrations.sandicare.mx/api/v1/meetings/enroll \
  -H "Content-Type: application/json" \
  -H "x-api-key: prd_your_key" \
  -d '{
    "programId": "123456",
    "service": "general_medicine",
    "email": "[email protected]",
    "dateOfBirth": "1990-05-15",
    "consultationReason": "Headache and fever"
  }'

Example response

json
{
  "url": "https://example.mx/abc123xyz"
}
consultationReason is conditional — only required when service is general_medicine. Omit it for all other service types.