Documentation

ScanIO Guides

Comprehensive guides to help you master every aspect of the ScanIO platform.

Getting Started with ScanIO

Setup

Complete setup guide to get your first scan running in under 5 minutes.

5 min read
Beginner

Security Best Practices

Security

Essential security configurations and compliance standards for enterprise deployment.

12 min read
Intermediate

Advanced Data Analytics

Analytics

Leverage ScanIO's analytics engine to extract actionable insights from your scans.

8 min read
Advanced

Database Integration

Integration

Connect ScanIO with your existing database infrastructure seamlessly.

10 min read
Intermediate

Team Collaboration

Team

Set up roles, permissions, and workflows for your team's scanning operations.

6 min read
Beginner
Documentation

Documentation

Comprehensive guides and references for the ScanIO platform.

Getting Started

12 articles available

Quick Start Guide

guide5 min

Installation

tutorial3 min

Your First API Call

example8 min

Quick Example

// Quick Start Example
import { ScanioAPI } from '@scanio/sdk';

const api = new ScanioAPI({
  apiKey: 'your-api-key',
  environment: 'production'
});

// Create a new resource
const resource = await api.resources.create({
  name: 'My Resource',
  type: 'document',
  data: { content: 'Hello World' }
});

console.log(resource.id);
API Reference

ScanIO API

RESTful API with comprehensive documentation and SDKs for seamless integration.

REST Endpoints

POST/api/v1/scans

Create a new scan

curl -X POST https://api.scanio.com/v1/scans \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "https://example.com",
    "scan_type": "comprehensive",
    "options": {
      "deep_scan": true,
      "follow_redirects": true
    }
  }'
GET/api/v1/scans/{scan_id}

Retrieve scan results

curl -X GET https://api.scanio.com/v1/scans/scan_123 \
  -H "Authorization: Bearer YOUR_API_KEY"
GET/api/v1/reports

List all reports

curl -X GET https://api.scanio.com/v1/reports \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -G -d "limit=50" -d "status=completed"

SDKs

import { ScanioClient } from '@scanio/sdk';

const client = new ScanioClient({
  apiKey: process.env.SCANIO_API_KEY
});

const scan = await client.scans.create({
  target: 'https://example.com',
  scanType: 'comprehensive'
});

console.log(scan.id);

Quick Start

Get your API key from the dashboard and start making requests in seconds.