Integration Guide

SDK Integration Verification

Verify your Tork SDK installation and receive a verification certificate to display on your projects.

Overview

The Tork SDK includes a built-in verification system that tests your integration against our API. Running verification confirms that:

API Connectivity
Your SDK can reach the Tork API
Authentication
Your API key is valid and active
PII Detection
The PII redaction system works correctly
Policy Evaluation
Your policies are loaded and evaluated
Rate Limiting
Rate limits are properly configured
Webhooks (Optional)
Webhook delivery is working

Quick Start

Run verification using your SDK's built-in command:

🐍

Python

Terminal
# Install the SDK
pip install tork-sdk

# Run verification
tork verify

# Or programmatically
from tork import verify_installation

result = verify_installation()
print(f"Score: {result.score}/100 - Grade: {result.grade}")
print(f"Certificate: {result.certificate_url}")
📦

JavaScript / TypeScript

Terminal
# Install the SDK
npm install @tork-network/sdk

# Run verification via CLI
npx @tork-network/sdk verify

# Or programmatically
import { verifyInstallation } from '@tork-network/sdk';

const result = await verifyInstallation();
console.log(`Score: ${result.score}/100 - Grade: ${result.grade}`);
console.log(`Certificate: ${result.certificate_url}`);
🔵

Go

Terminal
# Install the SDK
go get github.com/tork-network/tork-go

# Run verification
package main

import (
    "fmt"
    "github.com/tork-network/tork-go"
)

func main() {
    client := tork.NewClient("your-api-key")
    result, _ := client.VerifyInstallation()

    fmt.Printf("Score: %d/100 - Grade: %s\n", result.Score, result.Grade)
    fmt.Printf("Certificate: %s\n", result.CertificateURL)
}
💎

Ruby

Terminal
# Install the SDK
gem install tork-sdk

# Run verification
require 'tork'

client = Tork::Client.new(api_key: 'your-api-key')
result = client.verify_installation

puts "Score: #{result.score}/100 - Grade: #{result.grade}"
puts "Certificate: #{result.certificate_url}"

API Reference

You can also call the verification API directly:

HTTP Request
POST https://tork.network/api/v1/health/integration
Authorization: Bearer your-api-key
Content-Type: application/json

{
  "sdk_type": "python",
  "sdk_version": "2.4.1",
  "tests_to_run": ["api_connectivity", "authentication", "pii_detection"],
  "webhook_url": "https://your-app.com/webhook" // optional
}
Response
{
  "status": "pass",
  "score": 95,
  "grade": "A",
  "sdk": {
    "type": "python",
    "version": "2.4.1"
  },
  "tests": {
    "api_connectivity": { "status": "pass", "latency_ms": 42 },
    "authentication": { "status": "pass", "key_type": "production" },
    "pii_detection": { "status": "pass", "detected": ["email", "phone"] },
    "policy_evaluation": { "status": "pass", "policies_loaded": 5 },
    "rate_limiting": { "status": "pass", "limit": 1000, "remaining": 998 }
  },
  "timestamp": "2026-01-25T10:30:00Z",
  "verification_id": "ver_abc123xyz",
  "certificate_url": "https://tork.network/verify/ver_abc123xyz"
}

Scoring & Grades

Your verification score is calculated based on the tests you run:

TestWeightDescription
API Connectivity20%Basic API reachability test
Authentication25%API key validation
PII Detection20%Test PII redaction functionality
Policy Evaluation20%Policy engine functionality
Rate Limiting10%Rate limit configuration
Webhook Delivery5%Optional webhook test
A+
97+
A
90+
B
80+
C
70+
D
60+
F
0+

Display Your Badge

If your score is 80 or higher, you'll receive a verification badge URL that you can display in your README or documentation:

Tork VerifiedA
Markdown
[![Tork Verified](https://tork.network/api/badge/your-verification-id)](https://tork.network/verify/your-verification-id)

Enterprise Features

Take advantage of our production-grade verification tools:

Ready to Verify?

Run the verification command in your SDK to test your integration and get your certificate.