Integration Guide

Integrate compliance monitoring into your applications and workflows with our comprehensive APIs, SDKs, and automation tools.

REST API
Official SDKs
Webhook Support

Integration Methods

Choose the integration approach that best fits your development workflow

Most Flexible

REST API

Direct integration with our RESTful API for complete control and customization

  • Complete API access
  • Custom implementations
  • Full control
  • Advanced features
Recommended

Official SDKs

Pre-built libraries for popular programming languages with built-in best practices

  • Easy integration
  • Built-in retries
  • Type safety
  • Official support
Real-time

Webhooks

Real-time notifications sent directly to your application when scans complete

  • Real-time updates
  • Event-driven
  • Secure delivery
  • Retry logic
No-Code

N8N Workflows

Visual workflow automation with pre-built compliance monitoring templates

  • No-code integration
  • Visual workflows
  • Pre-built templates
  • Automated triggers

Official SDKs

Production-ready libraries with built-in best practices and error handling

JavaScript/TypeScript

Official Node.js SDK with TypeScript support

Installation

npm install @compliance/sdk

Example Usage

Quick Start
import { ComplianceAPI } from '@compliance/sdk';

const client = new ComplianceAPI({
  apiKey: process.env.COMPLIANCE_API_KEY
});

const scan = await client.scans.create({
  url: 'https://example.com',
  regulations: ['GDPR', 'CCPA']
});

Python

Python SDK with async support and comprehensive type hints

Installation

pip install compliance-api

Example Usage

Quick Start
from compliance_api import ComplianceClient

client = ComplianceClient(
    api_key=os.getenv('COMPLIANCE_API_KEY')
)

scan = await client.scans.create(
    url='https://example.com',
    regulations=['GDPR', 'CCPA']
)

PHP

PHP SDK compatible with modern PHP frameworks

Installation

composer require compliance/sdk

Example Usage

Quick Start
<?php
use Compliance\SDK\ComplianceClient;

$client = new ComplianceClient([
    'api_key' => $_ENV['COMPLIANCE_API_KEY']
]);

$scan = $client->scans->create([
    'url' => 'https://example.com',
    'regulations' => ['GDPR', 'CCPA']
]);

N8N Workflow Templates

Pre-built automation workflows for common compliance monitoring scenarios

Automated Website Monitoring

Continuously monitor your website for compliance issues with automated scheduling

Triggers

Schedule-based
Content changes
Manual trigger

Actions

Compliance scan
Report generation
Email notifications
Slack alerts

CI/CD Pipeline Integration

Integrate compliance checking into your deployment pipeline for continuous compliance

Triggers

Git push
Deploy trigger
PR creation

Actions

Pre-deploy scan
Compliance validation
Build blocking
Status reporting

Multi-Site Compliance Dashboard

Monitor compliance across multiple websites from a centralized dashboard

Triggers

Scheduled scans
Bulk operations

Actions

Batch scanning
Consolidated reporting
Trend analysis
Alert aggregation

CI/CD Integration

Integrate compliance checking into your deployment pipeline

GitHub Actions

Integrate compliance checking into your GitHub workflow

name: Compliance Check
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  compliance:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Run Compliance Scan
        uses: compliance-check/action@v1
        with:
          api-key: ${{ secrets.COMPLIANCE_API_KEY }}
          url: https://staging.example.com
          fail-on-issues: true

GitLab CI

Add compliance checking to your GitLab pipeline

compliance_check:
  stage: test
  image: compliance/cli:latest
  script:
    - compliance-cli scan 
        --url https://staging.example.com
        --api-key $COMPLIANCE_API_KEY
        --output-format junit
  artifacts:
    reports:
      junit: compliance-report.xml
  only:
    - merge_requests
    - main

Jenkins

Jenkins pipeline integration with compliance checking

pipeline {
    agent any
    stages {
        stage('Deploy') {
            steps {
                // Your deployment steps
                sh 'deploy.sh staging'
            }
        }
        stage('Compliance Check') {
            steps {
                script {
                    sh '''
                        curl -X POST https://api.compliancecheck.com/v1/scans \
                          -H "Authorization: Bearer $COMPLIANCE_API_KEY" \
                          -H "Content-Type: application/json" \
                          -d '{"url": "https://staging.example.com"}'
                    '''
                }
            }
        }
    }
}

Webhook Configuration

Receive real-time notifications when scans complete

Setup Webhook

POST /api/v1/webhooks
{
  "url": "https://yourapp.com/webhook",
  "events": ["scan.completed", "scan.failed"],
  "secret": "your-webhook-secret"
}

Webhook Payload

{
  "event": "scan.completed",
  "scan_id": "scan_abc123",
  "url": "https://example.com",
  "status": "completed",
  "score": 85,
  "timestamp": "2025-01-15T10:35:00Z"
}

Webhooks are signed with HMAC-SHA256 using your webhook secret for security verification.

Start Integrating Today

Get your API key and choose your preferred integration method

Get API KeyView API Docs