Inicio rápido del SDK web¶

Esta página proporciona un ejemplo conceptual mínimo de cómo incorporar una verificación de confianza de Polyguard en una aplicación web. Para obtener la referencia completa del SDK, incluidas todas las opciones de configuración, tipos de eventos, manejo de errores y uso avanzado, consulte la documentación completa en dev.polyguard.ai.

Descripción general¶

El SDK web maneja la parte de una verificación de confianza orientada al usuario final en el navegador: mostrar el modo de verificación, coordinar la sesión de WebSocket con la aplicación móvil Polyguard y devolver los resultados a su aplicación mediante devoluciones de llamada.

El flujo de integración típico es:

1. Lado del servidor: cree un vínculo a través de la API REST (la fase de preparación).
2. Lado del cliente: inicialice el SDK web, inicie la verificación de confianza con la URL del enlace y administre los resultados.
3. Lado del servidor (opcional): reciba resultados a través de webhook para la validación del backend.

Paso 1: crear un enlace (del lado del servidor)¶

Antes de mostrar una verificación de confianza a un usuario final, su backend crea un enlace a través de la API REST de Polyguard. Esto requiere un token de sesión válido.

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

Paso 2: Inicialice el SDK (del lado del cliente)¶

Incluya el SDK web de Polyguard en su página e inicialícelo con su ID de aplicación.

<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
});

Paso 3: inicie una verificación de confianza¶

Active una verificación de confianza pasando la URL del enlace obtenida de su backend. El SDK abre una superposición modal donde el usuario final completa su verificación utilizando la aplicación móvil Polyguard.

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);
  },
});

Paso 4: Manejar los resultados (del lado del servidor, opcional)¶

Si su aplicación está configurada con una URL de webhook, Polyguard también PUBLICARA los resultados de la verificación de confianza en su backend. Esto es útil para la validación y el mantenimiento de registros del lado del servidor, independientemente de lo que suceda en el navegador.

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 frente a producción¶

El SDK web admite un entorno sandbox para desarrollo y pruebas. Las comprobaciones de confianza de Sandbox simulan el flujo de verificación sin requerir documentos de identidad reales o un dispositivo móvil físico.

Cambie de entorno cambiando el parámetro environment durante la inicialización del SDK.

¿Qué sigue?¶

• Referencia completa del SDK: dev.polyguard.ai: opciones de configuración completas, tipos de eventos, temas y códigos de error.
• Documentos de la API REST: api-global.polyguard.ai/docs -- Creación de enlaces, gestión de sesiones, auditoría de puntos finales.
• SDK móvil: Disponible por separado bajo licencia. Comuníquese con Polyguard para obtener acceso.
• Trust Check Lifecycle - Comprenda el flujo trifásico completo.
• Autenticación y autorización: tokens de sesión, SSO y certificación de hardware.