API Documentation

import type { Scan, Analysis, ScanStatus, ThreatLevel } from './types';

// 1. Create a new scan
async function createScan(url: string): Promise<Scan> {
  const response = await fetch("https://api.urlert.com/v1/scans", {
    method: "POST",
    headers: {
      "X-API-Key": "your-api-key-here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ url })
  });
  return await response.json();
}

// 2. Poll for scan results
async function checkScanStatus(scanId: string): Promise<Scan> {
  const response = await fetch(`https://api.urlert.com/v1/scans/${scanId}`, {
    headers: { "X-API-Key": "your-api-key-here" }
  });
  return await response.json();
}

// 3. Complete workflow with polling
async function analyzeSite(url: string) {
  // Start the scan
  const scan = await createScan(url);
  console.log("Scan created:", scan.id);

  // Poll for results
  while (true) {
    const result = await checkScanStatus(scan.id);
    
    if (result.status === "FAILED") {
      console.error("Scan failed:", result.error);
      break;
    }
    
    if (result.status === "ANALYZED") {
      console.log("Scan completed!");
      console.log("Threat Level:", result.analysis?.threatLevel);
      console.log("Confidence:", result.analysis?.confidence);
      console.log("Final URL:", result.analysis?.finalUrl);
      console.log("Malicious Reasons:", result.analysis?.maliciousReasons);
      break;
    }

    // Wait 2 seconds before next check
    await new Promise(resolve => setTimeout(resolve, 2000));
  }
}

// Usage
analyzeSite("https://example.com");

from enum import Enum
import time
import requests
from typing import Optional, List, Dict

class ScanStatus(str, Enum):
    PENDING = "PENDING"
    FAILED = "FAILED"
    SCRAPED = "SCRAPED"
    ANALYZED = "ANALYZED"

API_KEY = "your-api-key-here"
BASE_URL = "https://api.urlert.com/v1"

def create_scan(url: str) -> Dict:
    """Create a new scan and return the response."""
    response = requests.post(
        f"{BASE_URL}/scans",
        headers={
            "X-API-Key": API_KEY,
            "Content-Type": "application/json"
        },
        json={"url": url}
    )
    return response.json()

def check_scan_status(scan_id: str) -> Dict:
    """Check the status of a scan."""
    response = requests.get(
        f"{BASE_URL}/scans/{scan_id}",
        headers={"X-API-Key": API_KEY}
    )
    return response.json()

def analyze_site(url: str):
    """Complete workflow to analyze a site."""
    # Start the scan
    scan = create_scan(url)
    print(f"Scan created: {scan['id']}")

    # Poll for results
    while True:
        result = check_scan_status(scan['id'])
        
        if result['status'] == ScanStatus.FAILED:
            print("Scan failed:", result.get('error'))
            break
        
        if result['status'] == ScanStatus.ANALYZED:
            analysis = result.get('analysis', {})
            print("Scan completed!")
            print("Threat Level:", analysis.get('threatLevel'))
            print("Confidence:", analysis.get('confidence'))
            print("Final URL:", analysis.get('finalUrl'))
            print("Malicious Reasons:", analysis.get('maliciousReasons', []))
            break

        # Wait 2 seconds before next check
        time.sleep(2)

# Usage
analyze_site("https://example.com")