إنتقل إلى المحتوى الرئيسي

Getting Started Overview

Welcome to Najeeb Health Suite! This guide will help you understand the platform and get started with integration.

What is Najeeb Health Suite?​

Najeeb Health Suite is a SaaS API platform that provides insurance companies in KSA with:

  • Healthcare Data Management: Access and manage patient information, claims, and provider data
  • Real-time Processing: Submit and track claims, authorizations, and other healthcare transactions
  • Secure Integration: Enterprise-grade security with OAuth 2.0 authentication
  • Scalable Infrastructure: Handle high volumes of requests with reliable, high-performance APIs

Architecture Overview​

┌─────────────────┐
│  Your System    │
│  (Insurance     │
│   Platform)     │
└────────┬────────┘
         │
         │ HTTPS/REST API
         │
┌────────▼────────┐
│  Najeeb Health  │
│  Suite API      │
│  Gateway        │
└────────┬────────┘
         │
    ┌────┴────┐
    │         │
┌───▼───┐ ┌──▼────┐
│Claims │ │Patient│
│Service│ │Service│
└───────┘ └───────┘

Core Concepts​

API Endpoints​

All API requests are made to our base URL: https://api.najeeb.com/v1

Authentication​

Najeeb Health Suite uses OAuth 2.0 for secure API access. You'll need:

  • Client ID: Provided when you sign up
  • Client Secret: Keep this secure and never expose it publicly
  • Access Token: Obtained through the authentication endpoint

Data Formats​

  • Request/Response: JSON format
  • Content-Type: application/json
  • Character Encoding: UTF-8

Rate Limits​

  • Standard Tier: 1,000 requests per minute
  • Enterprise Tier: Custom limits based on your needs
Rate Limits

If you exceed rate limits, you'll receive a 429 Too Many Requests response. Implement exponential backoff for retries.

Integration Flow​

  1. Get Credentials: Sign up and receive your API credentials
  2. Authenticate: Obtain an access token using OAuth 2.0
  3. Make API Calls: Use the access token to make authenticated requests
  4. Handle Responses: Process responses and handle errors appropriately
  5. Set Up Webhooks: Configure webhooks for real-time event notifications

Next Steps​