Relationship Compatibility API - Django Integration

Overview

Calculate relationship compatibility percentage and analysis

POST /v2/astrology/compatibility-score

Pricing: $0.008 per request | Framework: Django | Auth: API Key required

Quick Start

1. Installation

pip install requests

2. Environment Setup

# .env
VEDIKA_API_KEY=your_api_key_here

Security: Never commit API keys to version control. Always use environment variables.

Complete Implementation

# compatibility/views.py
import os
import requests
from django.conf import settings
from django.http import JsonResponse
from django.views.decorators.http import require_http_methods
from django.views.decorators.csrf import csrf_exempt
import json

VEDIKA_BASE_URL = 'https://vedika-api-854222120654.us-central1.run.app'

def get_compatibility(params):
    """
    Calculate relationship compatibility percentage and analysis
    """
    headers = {
        'Content-Type': 'application/json',
        'x-api-key': settings.VEDIKA_API_KEY
    }

    try:
        response = requests.post(
            f'{VEDIKA_BASE_URL}/v2/astrology/compatibility-score',
            json=params,
            headers=headers,
            timeout=10
        )
        response.raise_for_status()
        return response.json()
    except requests.exceptions.RequestException as e:
        raise Exception(f'Vedika API Error: {str(e)}')

@csrf_exempt
@require_http_methods(['POST'])
def compatibility_view(request):
    """
    Django view for Relationship Compatibility
    """
    try:
        data = json.loads(request.body)
        result = get_compatibility(data)
        return JsonResponse(result, status=200)
    except Exception as e:
        return JsonResponse({'error': str(e)}, status=500)

# urls.py:
# from compatibility.views import compatibility_view
# urlpatterns = [
#     path('api/compatibility/', compatibility_view, name='compatibility'),
# ]

# settings.py:
# VEDIKA_API_KEY = os.getenv('VEDIKA_API_KEY')

Request Parameters

Parameter	Type	Required	Description
`person1Details`	varies	Yes	See API documentation
`person2Details`	varies	Yes	See API documentation

Error Handling

Status Code	Error	Solution
400	Bad Request	Check request parameters and format
401	Unauthorized	Verify API key is correct
402	Payment Required	Insufficient balance - recharge at console.vedika.io
429	Rate Limit Exceeded	Implement exponential backoff or upgrade plan
500	Server Error	Retry after a few seconds

Best Practices

Secure API Keys: Always use environment variables, never hardcode
Error Handling: Implement comprehensive error handling for all status codes
Caching: Cache responses when appropriate to reduce costs
Timeout: Set reasonable timeout values (10-30 seconds)
Rate Limiting: Implement client-side rate limiting to avoid 429 errors
Validation: Validate input parameters before making API calls
Logging: Log API errors for debugging and monitoring
Testing: Use sandbox endpoints for development and testing

Response Format

{
  "success": true,
  "data": {
    // Endpoint-specific response data
  },
  "timestamp": "2026-01-07T10:30:00Z",
  "cost": 0.008
}

Related Endpoints

Birth Chart Kundli Match Panchang Dasha Periods Dosha Analysis

Other Frameworks

React Next.js Vue.js Angular Node.js Python/Flask Ruby on Rails

Support

Need help integrating this endpoint?

Email: support@vedika.io
Documentation: vedika.io/docs
API Console: console.vedika.io
GitHub Examples: github.com/vedika-io/examples