CyberShield SDK Overview¶
The CyberShield SDK enables developers to integrate threat detection, file analysis, and security monitoring capabilities directly into their applications.
Key Features¶
- Lightweight and modular design
- Fast threat-scan engine
- File hash analysis
- Real-time system monitoring
- Simple authentication and setup process
When to Use the SDK¶
| Scenario | Why the SDK Helps | Example |
|---|---|---|
| Local application analysis | Perform scans without sending files outside the environment. | Desktop or on-premise apps |
| Real-time endpoint monitoring | Detect suspicious processes as they run. | Endpoint security tools |
| Preprocessing files | Extract hashes and metadata before storage or further processing. | Ingestion pipelines, CI/CD |
| Embedded security features | Add scanning into existing business workflows. | SaaS platforms, internal systems |
Before You Begin¶
You will need:
- A valid CyberShield API Key
- Access to the CyberShield backend (Production or Sandbox)
- Basic understanding of HTTP requests
- A development environment where the SDK will be embedded
💡 Note: The SDK works best when paired with proper logging and monitoring workflows.
What's Next?¶
To get started with the SDK, begin with the core setup sequence:
Modules¶
The CyberShield SDK includes three core functional modules:
- Threat Scan — Scan files and memory for harmful or suspicious content.
- File Analysis — Extract metadata, hashes, and risk indicators.
- System Monitor — Track active processes and unusual system behavior.
Additional Help¶
If you encounter issues while using the SDK, refer to: