Quick Start
get started with API integration in a few steps
This is published as part of general awareness/guidance and is not intended for production use, content is still in draft phase, please have a look at Sehhati roadmap to understand at which phase you can start using the API's!!
Get your API keys
You need to register on developer portal using https://developer.sehhati.ae/register, once registered you can get your API keys.
Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error. You can generate an API key from your Dashboard at any time.
Use a web service integration tool
The best way to interact with our API is to use one of our Postman collections:
https://www.postman.com/downloads/
import collection to your space <..add collection link..>
update your API key using postman https://learning.postman.com/docs/sending-requests/authorization/#api-key
Make your first request
To make your first request, send an authenticated request to the referral gateway endpoint. This will give show you our API in action.
get referral requirements.
GET https://api-dev.sehhati.ae/v1/referral
check referral requirements
Request Body
nationalId*
string
The national ID of patient
gender*
string
The gender of the patient M: male, F: female, U: unknown
DoB*
string
The date of birth of patient in the format of dd/mm/yyyy
serviceType*
string
Patient's desired medical service type for community care
Available values : Audiology, Cardiology, Dermatology, Gastroenterology, Gynecology, MentalHealthCare, Nutrition, Ophthalmology, Optometry, Orthopedics, Podiatry, PrimaryCare, Urology, WomensHealth
Example : Gastroenterology
{
"name":"Ahmad Ali",
"referralRequired":"yes"
"timestamp":"2022-11-15T13:17:58.250Z"
}please check provided api key
Take a look at how you might call this method using our official libraries, or via curl:
curl https://api-dev.sehhati.ae/v1/referral
-u YOUR_API_KEY:
-d nationalId='784-1234-9876543-2'
-d gender='M'
-d dob='22-11-1999'
-d serviceType='MentalHealthCare' // require the myapi module and set it up with your API key
const myapi = require('myapi')(YOUR_API_KEY);
const newReferralCheck = away myapi.referral.create({
nationalId:'784-1234-9876543-2' ,
gender: 'M',
dob: '22-11-1999',
serviceType: 'MentalHealthCare'
})// Set your API key before making the request
myapi.api_key = YOUR_API_KEY
myapi.Pet.create(
nationalId='784-1234-9876543-2' ,
gender= 'M',
dob= '22-11-1999',
serviceType= 'MentalHealthCare'
)Last updated