Home
UCWI WebService API
Introduces the WebService API provided by UCWI devices and related information.
Overview
Introduces Unified Content Web-Service Inspector (UCWI).
Technical Feature List
Lists the technical features of the product.

UCWI WebService API
Introduces the WebService API provided by UCWI devices and related information.
- Overview
  Introduces Unified Content Web-Service Inspector (UCWI).
  - Typical Deployment - Big Data Platform
    Introduces information about the deployment of big data platforms.
  - Technical Feature List
    Lists the technical features of the product.
  - Typical Use Cases
    Introduces typical use cases for WebService API.
  - API List
    Lists the WebService APIs provided by UCWI.
  - Introduction to Content Receive Interface
    Introduce the basic information of the content receive interface.
  - Introduction to Content Inspection Interface
    Introduces the basic information of the content inspection interface.
  - Introduction to Return Values of the Content Inspection Interface
    Introduces the return values of the content inspection interface. If a policy is matched, the system will return the matched policy information.
  - Data Masking Policy
    Introduces information related to creating and managing data masking policies.
- Configure WebService API
  Introduces how to quickly configure the WebService API.
- Authentication
  Introduces the steps to obtain authentication information.
- GET-Get Channel List
  Introduces the interface call method for the Get Channel List interface.
- GET-Get Channel Details
  Introduces the interface call method for the Get Channel Details interface.
- GET-Get Incident List
  Introduces the invocation method of the Get Incident List interface.
- GET-Get Incident Details
  Introduces the interface call method for the Get Incident Details interface.
- GET-Get Policy Hit Statistics Report
  Introduces the interface call method for the Get Policy Hit Statistics Report.
- GET - Get Label
  Introduces the invocation method of the Get Label interface.
- POST -Add Label
  Introduces the invocation method of the Labeling interface.
- DELETE - Delete Label
  Introduces the interface invocation method of the Delete Label interface.
- POST-Content Review-Web Channel
  Introduces how to call the interface to perform security reviews on content in the Web channel.
- POST-Content Review-Email Channel
  Introduces how to call the interface to perform security reviews on content in the email channel.
- POST-Content Review-WebService Application Channel
  Introduces how to call the interface to perform security reviews of content in the WebService application channel.
- Data Masking Processing
  Introduces how to call the content review interface for data masking processing.
- POST-Virus Scan
  Introduces how to call the interface to perform virus scanning on text content.
- Upload Logs
  Introduction to the upload logs interface.
- Third-Party Log Management Platform Integration
  Introduces information about integrating with third-party log management platforms.
- Appendix
  This chapter introduces some relevant information that needs to be known when calling the WebService API.

Technical Feature List

Lists the technical features of the product.

Multiple Content Inspection Interface Modes

Synchronous Interface: The client submits local content to Unified Content Web-Service Inspector (UCWI) via a RESTful interface and waits for the inspection results to be returned after the analysis is complete.
Asynchronous Interface: The client submits content to Unified Content Web-Service Inspector (UCWI) via a RESTful interface in asynchronous mode without waiting for the analysis results. The inspection results can be queried later through the event query command, and the corresponding evidence files can be obtained through the evidence file query command.
External Review Interface: The content review interfaces for Web, Email, and WebService channels can review content stored in cloud services in asynchronous mode. Unified Content Web-Service Inspector (UCWI) specifically supports reviewing content in the following cloud storage services:
- Amazon S3
- OpenStack Swift
- Tencent Cloud COS
- Alibaba Cloud OSS

Multiple Content Detection Methods

File Parsing: Supports parsing of thousands of file formats, including compressed and nested files.
Image OCR: Can use Optical Character Recognition (OCR) module to recognize and analyze text contained in images.
Content Analysis: Supports various content comparison methods such as keywords, dictionaries, regular expressions, machine learning, and file fingerprints.
Anti-virus: Supports virus scanning of local text in synchronous mode and also supports scanning of various cloud storage content in asynchronous mode.