Init

This api is used to Initiate the Booking.

POST /abdm/uhi/v1/physical-consultation/booking/init

cURL

cURL

curl --request POST \
  --url https://api.eka.care/abdm/uhi/v1/physical-consultation/booking/init \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing": {
    "address": {
      "city": "<string>",
      "country": "<string>",
      "door": "<string>",
      "locality": "<string>",
      "name": "<string>",
      "state": "<string>"
    },
    "name": "<string>",
    "phone": "<string>"
  },
  "doctor_id": "<string>",
  "end_time": "<string>",
  "facility_id": "<string>",
  "price": {
    "currency": "<string>",
    "value": "<string>"
  },
  "provider_id": "<string>",
  "slot_id": "<string>",
  "start_time": "<string>",
  "transaction_id": "<string>"
}
'

import requests

url = "https://api.eka.care/abdm/uhi/v1/physical-consultation/booking/init"

payload = {
    "billing": {
        "address": {
            "city": "<string>",
            "country": "<string>",
            "door": "<string>",
            "locality": "<string>",
            "name": "<string>",
            "state": "<string>"
        },
        "name": "<string>",
        "phone": "<string>"
    },
    "doctor_id": "<string>",
    "end_time": "<string>",
    "facility_id": "<string>",
    "price": {
        "currency": "<string>",
        "value": "<string>"
    },
    "provider_id": "<string>",
    "slot_id": "<string>",
    "start_time": "<string>",
    "transaction_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billing: {
      address: {
        city: '<string>',
        country: '<string>',
        door: '<string>',
        locality: '<string>',
        name: '<string>',
        state: '<string>'
      },
      name: '<string>',
      phone: '<string>'
    },
    doctor_id: '<string>',
    end_time: '<string>',
    facility_id: '<string>',
    price: {currency: '<string>', value: '<string>'},
    provider_id: '<string>',
    slot_id: '<string>',
    start_time: '<string>',
    transaction_id: '<string>'
  })
};

fetch('https://api.eka.care/abdm/uhi/v1/physical-consultation/booking/init', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eka.care/abdm/uhi/v1/physical-consultation/booking/init",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billing' => [
        'address' => [
                'city' => '<string>',
                'country' => '<string>',
                'door' => '<string>',
                'locality' => '<string>',
                'name' => '<string>',
                'state' => '<string>'
        ],
        'name' => '<string>',
        'phone' => '<string>'
    ],
    'doctor_id' => '<string>',
    'end_time' => '<string>',
    'facility_id' => '<string>',
    'price' => [
        'currency' => '<string>',
        'value' => '<string>'
    ],
    'provider_id' => '<string>',
    'slot_id' => '<string>',
    'start_time' => '<string>',
    'transaction_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eka.care/abdm/uhi/v1/physical-consultation/booking/init"

	payload := strings.NewReader("{\n  \"billing\": {\n    \"address\": {\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"door\": \"<string>\",\n      \"locality\": \"<string>\",\n      \"name\": \"<string>\",\n      \"state\": \"<string>\"\n    },\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"doctor_id\": \"<string>\",\n  \"end_time\": \"<string>\",\n  \"facility_id\": \"<string>\",\n  \"price\": {\n    \"currency\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"provider_id\": \"<string>\",\n  \"slot_id\": \"<string>\",\n  \"start_time\": \"<string>\",\n  \"transaction_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.eka.care/abdm/uhi/v1/physical-consultation/booking/init")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billing\": {\n    \"address\": {\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"door\": \"<string>\",\n      \"locality\": \"<string>\",\n      \"name\": \"<string>\",\n      \"state\": \"<string>\"\n    },\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"doctor_id\": \"<string>\",\n  \"end_time\": \"<string>\",\n  \"facility_id\": \"<string>\",\n  \"price\": {\n    \"currency\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"provider_id\": \"<string>\",\n  \"slot_id\": \"<string>\",\n  \"start_time\": \"<string>\",\n  \"transaction_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/abdm/uhi/v1/physical-consultation/booking/init")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billing\": {\n    \"address\": {\n      \"city\": \"<string>\",\n      \"country\": \"<string>\",\n      \"door\": \"<string>\",\n      \"locality\": \"<string>\",\n      \"name\": \"<string>\",\n      \"state\": \"<string>\"\n    },\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"doctor_id\": \"<string>\",\n  \"end_time\": \"<string>\",\n  \"facility_id\": \"<string>\",\n  \"price\": {\n    \"currency\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"provider_id\": \"<string>\",\n  \"slot_id\": \"<string>\",\n  \"start_time\": \"<string>\",\n  \"transaction_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "order_id": "<string>",
  "provider_id": "<string>",
  "txn_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "source_error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "code": 123,
  "error": "<string>",
  "source_error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id · string

Eka User ID (OID)

X-Partner-Pt-Id · string

Partner User ID

X-Hip-Id · string

Partner HIP ID

Body

application/json

billing · object

Billing information for the appointment

Show child attributes

doctor_id · string

Unique identifier of the doctor associated with the slot

end_time · string

End time of the appointment (24H format, ISO 8601 supported)

facility_id · string

Optional facility or branch identifier if applicable

price · object

Price details of the consultation

Show child attributes

provider_id · string

Unique identifier of the healthcare provider or hospital

slot_id · string

Unique identifier of the selected slot

start_time · string

Start time of the appointment (24H format, ISO 8601 supported)

transaction_id · string

Unique transaction identifier for slot booking received in the previous api response

Response

200

application/json

OK

order_id · string

Unique booking/order ID

provider_id · string

Provider ID for the next API call

txn_id · string

Unique transaction ID for the next API call