वेब एसडीके त्वरित प्रारंभ¶

यह पृष्ठ एक वेब एप्लिकेशन में पॉलीगार्ड ट्रस्ट चेक को एम्बेड करने का एक न्यूनतम वैचारिक उदाहरण प्रदान करता है। संपूर्ण SDK संदर्भ के लिए - जिसमें सभी कॉन्फ़िगरेशन विकल्प, ईवेंट प्रकार, त्रुटि प्रबंधन और उन्नत उपयोग शामिल हैं - dev.polyguard.ai पर पूर्ण दस्तावेज़ देखें।

सिंहावलोकन¶

वेब एसडीके ब्राउज़र में ट्रस्ट चेक के अंतिम-उपयोगकर्ता-सामना वाले हिस्से को संभालता है: सत्यापन मोडल प्रदर्शित करना, पॉलीगार्ड मोबाइल ऐप के साथ वेबसॉकेट सत्र का समन्वय करना, और कॉलबैक के माध्यम से आपके एप्लिकेशन पर परिणाम लौटाना।

विशिष्ट एकीकरण प्रवाह है:

1. सर्वर-साइड: REST API (तैयारी चरण) के माध्यम से एक लिंक बनाएं।
2. क्लाइंट-साइड: वेब एसडीके को आरंभ करें, लिंक यूआरएल के साथ ट्रस्ट जांच शुरू करें और परिणामों को संभालें।
3. सर्वर-साइड (वैकल्पिक): बैकएंड सत्यापन के लिए वेबहुक के माध्यम से परिणाम प्राप्त करें।

चरण 1: एक लिंक बनाएं (सर्वर-साइड)¶

किसी अंतिम उपयोगकर्ता को ट्रस्ट चेक प्रदर्शित करने से पहले, आपका बैकएंड पॉलीगार्ड रेस्ट एपीआई के माध्यम से एक लिंक बनाता है। इसके लिए एक वैध सत्र टोकन की आवश्यकता है।

import requests

response = requests.post(
    "https://api-global.polyguard.ai/api/v1/links",
    headers={"Authorization": f"Bearer {session_token}"},
    json={
        "title": "Identity Verification",
        "required_proofs": ["government_id", "pg_presence"],
    },
)

link_data = response.json()
link_url = link_data["url"]  # Pass this to the frontend

चरण 2: एसडीके (क्लाइंट-साइड) प्रारंभ करें¶

अपने पेज में पॉलीगार्ड वेब एसडीके शामिल करें और इसे अपनी ऐप आईडी से आरंभ करें।

<script src="https://cdn.polyguard.ai/sdk/latest/polyguard.js"></script>

// Initialize the SDK with your App ID
const polyguard = new Polyguard({
  appId: "your-app-id",
  environment: "production",  // or "sandbox" for testing
});

चरण 3: विश्वास जांच शुरू करें¶

अपने बैकएंड से प्राप्त लिंक यूआरएल को पास करके विश्वास जांच शुरू करें। एसडीके एक मोडल ओवरले खोलता है जहां अंतिम उपयोगकर्ता पॉलीगार्ड मोबाइल ऐप का उपयोग करके अपना सत्यापन पूरा करता है।

polyguard.startTrustCheck({
  linkUrl: linkUrl,  // From Step 1

  onComplete: (result) => {
    // Trust check completed successfully
    console.log("Verification status:", result.status);
    console.log("Session ID:", result.sessionId);
    console.log("Proofs presented:", result.proofs);

    // Update your UI -- e.g., unlock the next step
    showVerifiedState(result);
  },

  onError: (error) => {
    // Trust check failed or was cancelled
    console.error("Trust check error:", error.code, error.message);

    // Handle gracefully -- e.g., offer retry
    showErrorState(error);
  },

  onStatusChange: (status) => {
    // Optional: track progress through the trust check
    // e.g., "waiting_for_mobile", "verifying", "processing"
    updateProgressIndicator(status);
  },
});

चरण 4: परिणाम संभालें (सर्वर-साइड, वैकल्पिक)¶

यदि आपका ऐप वेबहुक यूआरएल के साथ कॉन्फ़िगर किया गया है, तो पॉलीगार्ड आपके बैकएंड पर ट्रस्ट जांच परिणाम भी पोस्ट करेगा। यह सर्वर-साइड सत्यापन और रिकॉर्ड-कीपिंग के लिए उपयोगी है, ब्राउज़र में क्या होता है उससे स्वतंत्र।

from flask import Flask, request

app = Flask(__name__)

@app.route("/webhooks/polyguard", methods=["POST"])
def handle_polyguard_webhook():
    payload = request.json

    session_id = payload["session_id"]
    status = payload["status"]
    proofs = payload["proofs"]

    # Validate and store the result server-side
    record_verification(session_id, status, proofs)

    return "", 200

सैंडबॉक्स बनाम उत्पादन¶

वेब एसडीके विकास और परीक्षण के लिए sandbox वातावरण का समर्थन करता है। सैंडबॉक्स ट्रस्ट चेक वास्तविक पहचान दस्तावेजों या भौतिक मोबाइल डिवाइस की आवश्यकता के बिना सत्यापन प्रवाह का अनुकरण करते हैं।

SDK आरंभीकरण के दौरान environment पैरामीटर को बदलकर परिवेश बदलें।

आगे क्या होगा¶

• पूर्ण एसडीके संदर्भ: dev.polyguard.ai -- पूर्ण कॉन्फ़िगरेशन विकल्प, ईवेंट प्रकार, थीम और त्रुटि कोड।
• REST API डॉक्स: api-global.polyguard.ai/docs -- लिंक निर्माण, सत्र प्रबंधन, ऑडिट एंडपॉइंट।
• मोबाइल एसडीके: लाइसेंस के तहत अलग से उपलब्ध है। पहुंच के लिए पॉलीगार्ड से संपर्क करें।
• विश्वास जांच जीवनचक्र--पूर्ण तीन-चरण प्रवाह को समझें।
• प्रमाणीकरण और प्राधिकरण--सत्र टोकन, एसएसओ, और हार्डवेयर सत्यापन।