> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scanoss.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Interfaces & Integrations

> Interfaces & Integrations covers calling SCANOSS directly through SDKs and REST APIs, automating scanning across your CI/CD pipeline, monitoring vulnerabilities over time, and controlling network access. Choose your approach based on your specific needs.

Interfaces & Integrations covers every way to bring SCANOSS into your existing stack: calling it directly through SDKs and REST APIs, automating scans in CI/CD, tracking vulnerabilities over time, generating compliance reports, and routing API traffic through a controlled proxy.

If you followed the [Evaluation Path](/en/latest/poc/evaluation/getting-started), you've already set up GitHub Actions and Dependency Track as part of [CI/CD Integration](/en/latest/poc/evaluation/cicd-integration) and [Continuous Monitoring](/en/latest/poc/evaluation/continuous-monitoring). This page is the full reference: every supported integration, including CI/CD platforms not covered in that guided walkthrough.

## What Do You Need?

```mermaid theme={null}
graph TD
InterfacesStart[Interfaces & Integrations]

    InterfacesStart --> Purpose[What do you need?]

    Purpose -->|SDKs| SDKTools

    subgraph SDKTools[" "]
        direction LR
        PySDK[Python SDK]
        JavaSDK[Java SDK]
        JSSDK[JavaScript SDK]
    end

    Purpose -->|Direct API Access| APITools

    subgraph APITools[" "]
        direction LR
        CompAPI[Component Search API]
        DepAPI[Dependencies API]
        GeoAPI[Geoprovenance API]
        LicAPI[License API]
        VulnAPI[Vulnerability API]
        CryptoAPI[Cryptography API]
        ScanAPI[Scanning API]
        Postman[Postman]
    end

    Purpose -->|CI/CD & Integrations| CICDTools

    subgraph CICDTools[" "]
        direction LR
        PreCommit[Pre-Commit Hooks]
        GHA[GitHub Actions]
        Azure[Azure DevOps]
        Jenkins[Jenkins]
        GitLab[GitLab CI/CD]
        Sonar[SonarQube]
        DT[Dependency Track]
        ORT[OSS Review Toolkit]
    end

    SDKTools -.->|optional| Proxy[Proxy Configuration]
    APITools -.->|optional| Proxy
    CICDTools -.->|optional| Proxy

    style InterfacesStart fill:#26A69A,stroke:#00897B,stroke-width:3px,color:#fff
    style Purpose fill:#4DB6AC,stroke:#26A69A,stroke-width:2px,color:#fff
    style Proxy fill:#80CBC4,stroke:#4DB6AC,stroke-width:2px,color:#fff

    style SDKTools fill:#E0F2F1,stroke:#26A69A,stroke-width:2px,color:#000
    style PySDK fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style JavaSDK fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style JSSDK fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000

    style APITools fill:#E0F2F1,stroke:#26A69A,stroke-width:2px,color:#000
    style CompAPI fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style DepAPI fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style GeoAPI fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style LicAPI fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style VulnAPI fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style CryptoAPI fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style ScanAPI fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style Postman fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000

    style CICDTools fill:#E0F2F1,stroke:#26A69A,stroke-width:2px,color:#000
    style PreCommit fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style GHA fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style Azure fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style Jenkins fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style GitLab fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style Sonar fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style DT fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000
    style ORT fill:#B2DFDB,stroke:#80CBC4,stroke-width:2px,color:#000

    click PySDK "/en/latest/sdks/python/overview" "Python SDK" _blank
    click JavaSDK "/en/latest/sdks/java/overview" "Java SDK" _blank
    click JSSDK "/en/latest/sdks/javascript/overview" "JavaScript SDK" _blank
    click CompAPI "/en/latest/apis/component-search-api" "Component Search API" _blank
    click DepAPI "/en/latest/apis/dependencies-api" "Dependencies API" _blank
    click GeoAPI "/en/latest/apis/geoprovenance-api" "Geoprovenance API" _blank
    click LicAPI "/en/latest/apis/license-api" "License API" _blank
    click VulnAPI "/en/latest/apis/vulnerability-api" "Vulnerability API" _blank
    click CryptoAPI "/en/latest/apis/encryption-api" "Cryptography API" _blank
    click ScanAPI "/en/latest/apis/scanning-api" "Scanning API" _blank
    click Postman "/en/latest/apis/postman/workspace-setup" "Postman" _blank
    click PreCommit "/en/latest/integrations/pre-commit-hooks" "Pre-Commit Hooks" _blank
    click GHA "/en/latest/integrations/github-actions" "GitHub Actions" _blank
    click Azure "/en/latest/integrations/azure-devops" "Azure DevOps" _blank
    click Jenkins "/en/latest/integrations/jenkins" "Jenkins" _blank
    click GitLab "/en/latest/integrations/gitlab" "GitLab CI/CD" _blank
    click Sonar "/en/latest/integrations/sonarqube" "SonarQube" _blank
    click DT "/en/latest/integrations/dependency-track" "Dependency Track" _blank
    click ORT "/en/latest/integrations/oss-review-toolkit" "OSS Review Toolkit" _blank
    click Proxy "/en/latest/configuration/proxy-configuration" "Proxy Configuration" _blank
```

## SDKs

Call the SCANOSS API and scanning engine directly from your application code, using the language your project is already written in.

| Tool                                                                             | Best For                                                 |
| -------------------------------------------------------------------------------- | -------------------------------------------------------- |
| <a href="/en/latest/sdks/python/overview" target="_blank">Python SDK</a>         | Integrating SCANOSS into Python scripts and applications |
| <a href="/en/latest/sdks/java/overview" target="_blank">Java SDK</a>             | Integrating SCANOSS into Java projects                   |
| <a href="/en/latest/sdks/javascript/overview" target="_blank">JavaScript SDK</a> | Integrating SCANOSS into JavaScript and Node.js projects |

## Direct API Access

Query the SCANOSS REST API directly for full control over requests and responses, without a client library or CLI tool in between. New to the API? Start with the [API Overview](/en/latest/apis/api-overview).

| Tool                                                                                    | Best For                                                                                      |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| <a href="/en/latest/apis/component-search-api" target="_blank">Component Search API</a> | Searching components and retrieving versions, metadata, code statistics, and lifecycle status |
| <a href="/en/latest/apis/dependencies-api" target="_blank">Dependencies API</a>         | Resolving direct and transitive dependencies                                                  |
| <a href="/en/latest/apis/geoprovenance-api" target="_blank">Geoprovenance API</a>       | Identifying the geographical provenance of components                                         |
| <a href="/en/latest/apis/license-api" target="_blank">License API</a>                   | Retrieving license information, including SPDX details and approval status                    |
| <a href="/en/latest/apis/vulnerability-api" target="_blank">Vulnerability API</a>       | Retrieving CPE identifiers and known vulnerabilities (CVEs)                                   |
| <a href="/en/latest/apis/encryption-api" target="_blank">Cryptography API</a>           | Analysing cryptographic algorithms, usage hints, and version coverage                         |
| <a href="/en/latest/apis/scanning-api" target="_blank">Scanning API</a>                 | High-precision scanning of folder structures to identify components                           |
| <a href="/en/latest/apis/postman/workspace-setup" target="_blank">Postman</a>           | Exploring and testing SCANOSS API endpoints without writing code                              |

## CI/CD & Integrations

Run SCANOSS scans automatically as part of your build or pull request pipeline, then keep monitoring and enforcing policy after the scan is done, whichever platform your team already uses.

| Tool                                                                                              | Best For                                                                                                                |
| ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| <a href="/en/latest/integrations/pre-commit-hooks" target="_blank">Pre-Commit Hooks</a>           | Catching undeclared components before code is even pushed                                                               |
| <a href="/en/latest/integrations/github-actions" target="_blank">GitHub Actions</a>               | Scanning pull requests and enforcing policies in GitHub-hosted pipelines                                                |
| <a href="/en/latest/integrations/azure-devops" target="_blank">Azure DevOps</a>                   | Scanning pull requests and enforcing policies in Azure Pipelines                                                        |
| <a href="/en/latest/integrations/jenkins" target="_blank">Jenkins</a>                             | Scanning builds in self-hosted Jenkins pipelines                                                                        |
| <a href="/en/latest/integrations/gitlab" target="_blank">GitLab CI/CD</a>                         | Scanning pipelines and merge requests in GitLab                                                                         |
| <a href="/en/latest/integrations/sonarqube" target="_blank">SonarQube</a>                         | Surfacing SCANOSS findings alongside your existing SonarQube code quality checks                                        |
| <a href="/en/latest/integrations/dependency-track" target="_blank">Dependency Track</a>           | Continuously monitoring your SBOM for new vulnerabilities, license risks, and policy violations as they emerge          |
| <a href="/en/latest/integrations/oss-review-toolkit" target="_blank">OSS Review Toolkit (ORT)</a> | Generating compliance reports and managing open source licenses with an enterprise-grade FOSS policy automation toolkit |

## Network & Security

Any of the interfaces above, SDKs, direct API calls, or CI/CD tooling, can optionally route through a controlled proxy instead of calling the SCANOSS API directly.

[**Proxy Configuration**](/en/latest/configuration/proxy-configuration) routes SCANOSS API traffic through a controlled proxy for centralised key management, security, and audit logging.

Need help? [Contact our AI assistant](?assistant=open)
