Getting Started

复制一个包含安装步骤和本插件的完整Markdown指南的设置提示。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-ssl-pinning`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/ssl-pinning/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

bun add @capgo/capacitor-ssl-pinning
bunx cap sync

导入

import { SSLPinning } from '@capgo/capacitor-ssl-pinning';

API 概述

`getConfiguration`

返回当前可见于插件的活跃本机配置。

import { SSLPinning } from '@capgo/capacitor-ssl-pinning';

await SSLPinning.getConfiguration();

类型参考

`SSLPinningConfigurationState`

当前可见于插件的静态 SSL pinning 配置。

export interface SSLPinningConfigurationState {
  /**
   * Whether at least one certificate is configured for native pinning.
   */
  configured: boolean;

  /**
   * Certificate paths from `capacitor.config.*` relative to the app root.
   */
  certs: string[];

  /**
   * Fully-qualified URLs that should bypass SSL pinning.
   */
  excludedDomains: string[];
}

`PluginVersionResult`

插件版本 payload。

export interface PluginVersionResult {
  /**
   * Version identifier returned by the platform implementation.
   */
  version: string;
}

真实数据来源

此页面由插件生成 src/definitions.ts当公共API上游发生变化时，请重新同步。

继续从入门

如果您正在使用入门来规划安全性和合规性，请将其与使用@capgo/capacitor-ssl-pinning 在使用@capgo/capacitor-ssl-pinning中加密为加密的实现细节合规性为合规性的实现细节 Capgo 安全扫描器为产品工作流程在 Capgo 安全扫描器中,并 Capgo 安全为产品工作流程在 Capgo 安全中