அங்கீகார வழிகாட்டி

API விசைகள், JWT டோக்கன்கள், மற்றும் OAuth 2.0 ஐப் பயன்படுத்தி Smart Money API உடன் அங்கீகாரம் பெறுவது எப்படி என்பதைக் கற்றுக்கொள்ளுங்கள். தொழில்துறை தரநிலை அங்கீகார முறைகள் மற்றும் சிறந்த நடைமுறைகளுடன் உங்கள் ஒருங்கிணைப்புகளைப் பாதுகாக்கவும்.

கண்ணோட்டம்

Smart Money API பல்வேறு பயன்பாட்டு நிகழ்வுகளுக்காக பல அங்கீகார முறைகளை ஆதரிக்கிறது. உங்கள் ஒருங்கிணைப்புக்கு ஏற்ற முறையைத் தேர்ந்தெடுக்கவும்:

API விசைகள் (முதன்மை): உங்கள் விசையை அனுப்பவும் X-API-Key அனைத்து REST API அழைப்புகளுக்கும் கோரிக்கை தலைப்பு. இது போட்கள் மற்றும் சேவையகம்-க்கு-சேவையகம் பயன்பாட்டிற்கு பரிந்துரைக்கப்படும் முறை.

அமர்வு JWT (காப்பு): உலாவி/டாஷ்போர்டு அமர்வுகள் ஒரு அமர்வு JWT மூலம் அங்கீகாரம் பெறுகின்றன Authorization: Bearer, 24 மணி நேரம் செல்லுபடியாகும். நிரலாக்க வாடிக்கையாளர்கள் விரும்ப வேண்டும் X-API-Key.

OAuth 2.0: பல பயனர் பயன்பாடுகள் மற்றும் மூன்றாம் தரப்பு ஒருங்கிணைப்புகளுக்கான நிறுவன தர அங்கீகாரம். பயனர்கள் உங்கள் பயன்பாட்டை அவர்களின் தரவை அணுக அனுமதிக்கிறார்கள்.

அனைத்து API கோரிக்கைகளும் HTTPS மூலம் செய்யப்பட வேண்டும். குறியாக்கம் செய்யப்படாத HTTP கோரிக்கைகள் நிராகரிக்கப்படும். கூடுதலாக, API விசைகளை பதிப்பு கட்டுப்பாட்டில் சேர்க்காதீர்கள் அல்லது அவற்றை பொதுவாக பகிராதீர்கள்.

API விசைகள்

API விசைகள் உங்கள் கணக்கிற்கு வழங்கப்படும் தனித்துவமான சான்றுகள். ஒவ்வொரு விசையும் ஒரு தனி அனுமதிகள் மற்றும் கோட்டாக்களைக் குறிக்கிறது. வெவ்வேறு பயன்பாடுகள் அல்லது சூழல்களுக்கு (வளர்ச்சி, ஸ்டேஜிங், உற்பத்தி) பல விசைகளை உருவாக்கலாம்.

ஒரு API விசையை உருவாக்குதல்

உங்கள் கணக்கு கன்சோலில் இருந்து API விசைகளை உருவாக்கவும்:

வழிநடத்தவும் Smart Money Console
பக்கப்பட்டியில் இருந்து "API விசைகள்" என்பதைத் தேர்ந்தெடுக்கவும்
"புதிய விசையை உருவாக்கு" என்பதைக் கிளிக் செய்யவும்
விசை வகையைத் தேர்ந்தெடுக்கவும் (வளர்ச்சி, ஸ்டேஜிங், உற்பத்தி)
விகித வரம்பு மற்றும் அம்சங்களை அமைக்கவும்
விசையை நகலெடுத்து பாதுகாப்பாக சேமிக்கவும்

உங்கள் API விசையை உடனடியாக சேமிக்கவும்! அதை மீண்டும் பார்க்க முடியாது. அதை இழந்தால், நீங்கள் ஒரு புதிய விசையை உருவாக்க வேண்டும்.

விசை வடிவம்

API விசைகள் ஒரு நிலையான வடிவத்தைப் பின்பற்றுகின்றன:

விசை வடிவம்

sk_live_4e3e4d0f1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z
sk_test_8f4g5h6i7j8k9l0m1n2o3p4q5r6s7t8u9v0w1x2y3z4a5b6c7d8e9f
sk_dev_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b

விசை முன்னொட்டுகள் சூழலைக் குறிக்கின்றன:

sk_live_ — முழு கோட்டாவுடன் உற்பத்தி விசைகள்

sk_test_ — குறைக்கப்பட்ட கோட்டா மற்றும் வளர்ச்சி தரவுடன் சோதனை விசைகள்

sk_dev_ — சாண்ட்பாக்ஸ் தரவுடன் தனிப்பட்ட வளர்ச்சி விசைகள்

X-API-Key தலைப்பு (முதன்மை)

உங்கள் API விசையை அனுப்பவும் X-API-Key அனைத்து API கோரிக்கைகளுக்கும் கோரிக்கை தலைப்பு. உங்கள் விசையை ஒரு URL இல் வைக்காதீர்கள்.

HTTP தலைப்பு

HTTP

GET /v1/whales/events HTTP/1.1
Host: api.smartmoneyapi.com
X-API-Key: sm_your_key
Content-Type: application/json

cURL எடுத்துக்காட்டு

ஷெல்

curl -X GET https://api.smartmoneyapi.com/v1/whales/events \
  -H "X-API-Key: sm_your_key" \
  -H "Content-Type: application/json"

பைதான் எடுத்துக்காட்டு

பைதான்

import requests

api_key = "sm_your_key"
headers = {
    "X-API-Key": api_key,
    "Content-Type": "application/json"
}

response = requests.get(
    "https://api.smartmoneyapi.com/v1/whales/events",
    headers=headers
)

data = response.json()

JWT டோக்கன் அங்கீகாரம்

நீண்ட கால அமர்வுகள் மற்றும் சேவையகம்-க்கு-சேவையக தகவல்தொடர்புக்கு, உங்கள் API விசையை ஒரு JWT டோக்கனுக்கு மாற்றவும். JWT டோக்கன்கள் 24 மணி நேரம் நீடிக்கும் மற்றும் உங்கள் API விசையை பயன்பாட்டு குறியீட்டில் சேமிக்க வேண்டியதன் அவசியத்தைக் குறைக்கிறது.

JWT டோக்கன் பெறுதல்

ஒரு டோக்கன் பெற உங்கள் API விசையை JWT முனையத்திற்கு POST செய்யவும்:

cURL

curl -X POST https://api.smartmoneyapi.com/auth/jwt \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "sk_live_4e3e4d0f1b2c3d4e5f6g7h8i9j0k1l2m"
  }'

JWT பதில்

JSON

{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "expires_in": 86400,
  "token_type": "Bearer"
}

JWT டோக்கன் பயன்படுத்துதல்

API விசைகளைப் போலவே JWT டோக்கனை Authorization தலைப்பில் பயன்படுத்தவும்:

பைதான்

import requests
import json
from datetime import datetime, timedelta

class JWTAuth:
    def __init__(self, api_key):
        self.api_key = api_key
        self.token = None
        self.token_expires = None

    def get_valid_token(self):
        # Check if current token is still valid
        if self.token and self.token_expires > datetime.now():
            return self.token

        # Get new token
        response = requests.post(
            "https://api.smartmoneyapi.com/auth/jwt",
            json={"api_key": self.api_key}
        )

        data = response.json()
        self.token = data["token"]
        self.token_expires = datetime.now() + timedelta(seconds=data["expires_in"])

        return self.token

    def request(self, method, url, **kwargs):
        token = self.get_valid_token()
        headers = kwargs.get("headers", {})
        headers["Authorization"] = f"Bearer {token}"
        kwargs["headers"] = headers

        return requests.request(method, url, **kwargs)

# Usage
auth = JWTAuth("sk_live_4e3e4d0f1b2c3d4e5f6g7h8i9j0k1l2m")
response = auth.request(
    "GET",
    "https://api.smartmoneyapi.com/v1/whales/events"
)
print(response.json())

OAuth 2.0

OAuth 2.0 என்பது பல பயனர் கணக்குகளை அணுக வேண்டிய பயன்பாடுகளுக்கானது. பயனர்கள் உங்கள் பயன்பாட்டை அவர்களின் API விசைகளைப் பகிராமல் அவர்களின் தரவை அணுக அனுமதிக்கிறார்கள்.

OAuth 2.0 ஓட்டம்

Smart Money API வலை பயன்பாடுகளுக்கு அங்கீகார குறியீடு ஓட்டத்தை ஆதரிக்கிறது:

பயனர் "Smart Money உடன் இணைக்கவும்" பொத்தானைக் கிளிக் செய்கிறார்
உலாவி அங்கீகார பக்கத்திற்கு திருப்பி விடுகிறது
பயனர் உங்கள் பயன்பாட்டிற்கு அனுமதி அளிக்கிறார்
உலாவி அங்கீகார குறியீடுடன் திரும்பி விடுகிறது
உங்கள் பின்எண்ட் குறியீட்டை அணுகல் டோக்கனுக்கு மாற்றுகிறது
இப்போது நீங்கள் பயனரின் தரவை அவர்களின் சார்பாக அணுகலாம்

படி 1: அங்கீகார கோரிக்கை

பயனரை அங்கீகார முனையத்திற்கு திருப்பி விடவும்:

URL

https://auth.smartmoneyapi.com/authorize?
client_id=YOUR_CLIENT_ID&
redirect_uri=https://yourapp.com/callback&
response_type=code&
scope=whale_positions+funding_rates+liquidations&
state=random_state_string

படி 2: டோக்கன் பரிமாற்றம்

பயனர் அனுமதி அளித்த பிறகு, குறியீட்டை அணுகல் டோக்கனுக்கு மாற்றவும்:

cURL

curl -X POST https://auth.smartmoneyapi.com/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=authorization_code&code=AUTH_CODE&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&redirect_uri=https://yourapp.com/callback"

OAuth டோக்கன் பதில்

JSON

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "rt_1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p",
  "scope": "whale_positions funding_rates liquidations"
}

பாதுகாப்பு சிறந்த நடைமுறைகள்

விசைகளை பாதுகாப்பாக சேமிக்கவும்

API விசைகளை பதிப்பு கட்டுப்பாட்டில் சேர்க்காதீர்கள், பயன்பாடுகளில் கடினமாக்காதீர்கள் அல்லது ஆவணங்களில் பகிராதீர்கள். சூழல் மாறிகள் அல்லது AWS Secrets Manager, HashiCorp Vault போன்ற பாதுகாப்பான விசை மேலாண்மை சேவைகளைப் பயன்படுத்தவும்.

HTTPS ஐ மட்டும் பயன்படுத்தவும்

அனைத்து API கோரிக்கைகளும் HTTPS (TLS 1.2 அல்லது அதிகம்) பயன்படுத்த வேண்டும். HTTP கோரிக்கைகள் நிராகரிக்கப்படும். இது உங்கள் API விசை மற்றும் தரவு போக்குவரத்தில் குறியாக்கம் செய்யப்பட்டுள்ளது என்பதை உறுதி செய்கிறது.

விசை அனுமதிகளை வரம்பிடவும்

வெவ்வேறு பயன்பாடுகள் மற்றும் சூழல்களுக்கு தனி API விசைகளை உருவாக்கவும். ஒவ்வொரு விசையும் என்ன அணுக முடியும் என்பதை வரம்பிட நோக்கங்களைப் பயன்படுத்தவும். வளர்ச்சியில் உற்பத்தி விசைகளைப் பயன்படுத்தாதீர்கள்.

விசை பயன்பாட்டை கண்காணிக்கவும்

உங்கள் கன்சோலில் API பயன்பாட்டை தவறாமல் மதிப்பாய்வு செய்யவும். அசாதாரண செயல்பாடு அல்லது கோட்டா வரம்புகளை அணுகுவதற்கான எச்சரிக்கைகளை அமைக்கவும். நீங்கள் இனி பயன்படுத்தாத விசைகளை நீக்கவும்.

விசை சுழற்சி

உங்கள் API விசைகளை தவறாமல் சுழற்றவும், இது சிக்கலாகும் அபாயத்தைக் குறைக்கிறது. விசைகளை ஒவ்வொரு 90 நாட்களுக்கும் சுழற்ற பரிந்துரைக்கிறோம்:

உங்கள் கன்சோலில் ஒரு புதிய API விசையை உருவாக்கவும்
உங்கள் பயன்பாடுகளை புதிய விசையைப் பயன்படுத்துவதற்கு புதுப்பிக்கவும்
எல்லாம் சரியாக வேலை செய்கிறதா என சோதிக்கவும்
உங்கள் கன்சோலில் இருந்து பழைய விசையை நீக்கவும்

ஸ்கோப் & அனுமதிகள்

API விசைகளை உருவாக்கும்போது அல்லது OAuth ஐப் பயன்படுத்தும்போது, உங்கள் விசை எந்த வளங்களை அணுகலாம் என்பதைக் குறிப்பிடவும்:

ஸ்கோப்	விளக்கம்	டையர்
whale_positions	வேல் வாலட் நிலைகளைப் படிக்கவும்	Trader+
funding_rates	நிதியளிப்பு விகித தரவைப் படிக்கவும்	Free+
liquidations	திரைப்படங்களைப் படிக்கவும்	Free+
open_interest	திறந்த வட்டி தரவைப் படிக்கவும்	Trader+
confirmation_scores	AI உறுதிப்படுத்தல் மதிப்பெண்களைப் படிக்கவும்	Pro+
on_chain	ஆன்-செயின் மெட்ரிக்ஸைப் படிக்கவும்	Pro+

அங்கீகார குறியீடு எடுத்துக்காட்டுகள்

முழு பைதான் ஒருங்கிணைப்பு

Python

import requests
from typing import Optional, Dict
from datetime import datetime, timedelta

class SmartMoneyAuth:
    """Handles all authentication methods for Smart Money API"""

    def __init__(self, api_key: str):
        self.api_key = api_key
        self.base_url = "https://api.smartmoneyapi.com"
        self.jwt_token = None
        self.jwt_expires = None

    def get_jwt_token(self) -> str:
        """Get or refresh JWT token"""
        if self.jwt_token and self.jwt_expires > datetime.now():
            return self.jwt_token

        response = requests.post(
            f"{self.base_url}/auth/jwt",
            json={"api_key": self.api_key}
        )
        data = response.json()
        self.jwt_token = data["token"]
        self.jwt_expires = datetime.now() + timedelta(seconds=data["expires_in"] - 300)
        return self.jwt_token

    def headers_bearer(self) -> Dict:
        """Get headers for Bearer token auth"""
        return {
            "Authorization": f"Bearer {self.api_key}",
            "Content-Type": "application/json"
        }

    def headers_jwt(self) -> Dict:
        """Get headers for JWT auth"""
        token = self.get_jwt_token()
        return {
            "Authorization": f"Bearer {token}",
            "Content-Type": "application/json"
        }

    def request(self, method: str, endpoint: str, use_jwt: bool = False, **kwargs) -> Dict:
        """Make authenticated request"""
        headers = self.headers_jwt() if use_jwt else self.headers_bearer()
        response = requests.request(
            method,
            f"{self.base_url}{endpoint}",
            headers=headers,
            **kwargs
        )
        return response.json()

# Usage
auth = SmartMoneyAuth("sk_live_abc123xyz789")

# Bearer token method
whales = auth.request("GET", "/v1/whales/events?symbol=BTCUSDT")

# JWT method (auto-refreshing)
whales_jwt = auth.request("GET", "/v1/whales/events?symbol=BTCUSDT", use_jwt=True)

print(f"Found {whales['data']['total']} whale positions")

உதவி தேவையா?

அங்கீகாரத்தில் உதவி தேவைப்பட்டால் எங்கள் API ஆவணத்தை மதிப்பாய்வு செய்யவும் அல்லது ஆதரவைத் தொடர்பு கொள்ளவும்.

API குறிப்பு

உங்கள் முதல் API விசையை உருவாக்கவும்

Smart Money API உடன் தொடங்குங்கள். உங்கள் கணக்கை உருவாக்கி நிமிடங்களில் அங்கீகார சான்றுகளை உருவாக்கவும்.

கன்சோலுக்குச் செல்லவும்