# Capacitor SDK 快速入门

使用这个快速简单的示例开始使用 Pushwoosh Capacitor SDK

## 先决条件

要将 Pushwoosh Capacitor SDK 集成到您的应用中，您需要以下内容：

<TranslatedFragment id="prerequisites-plugins" />

## 下载示例项目

克隆 SDK 仓库：
```bash
git clone https://github.com/Pushwoosh/pushwoosh-capacitor-plugin.git
```

导航到插件目录：
```bash
cd pushwoosh-capacitor-plugin
```

## 构建插件

在运行示例应用之前，您需要构建 Capacitor 插件。
安装插件依赖项：
```bash
npm i
```

构建插件：
```bash
npm run build
```

## 配置示例应用

导航到示例应用目录：

```bash
cd example
```

安装应用依赖项：

```bash
npm i
```

构建 Web 资产：

```bash
npm run build
```

打开 **src/js/example.js** 并更新 `Pushwoosh.onDeviceReady` 调用：

```javascript
Pushwoosh.onDeviceReady({
    appid: "__YOUR_APP_CODE__"
});
```

其中：

`__YOUR_APP_CODE__` 是来自 Pushwoosh Control Panel 的 application code。

### iOS

###### 1. 安装 CocoaPods 依赖项

导航到 iOS 平台目录并安装 CocoaPods 依赖项：
```bash
cd ios/App
pod install --repo-update
cd ../..
```

###### 2. 将 Capacitor 同步到 iOS

安装 CocoaPods 后，同步 Capacitor 配置：

```bash
npx cap sync ios
```

###### 3. 打开 iOS 项目

在 Xcode 中打开项目：

```bash
npx cap open ios
```

###### 3. 设置 Bundle Identifier

在 Xcode 中，将 **Bundle Identifier** 设置为您的应用包名（例如，`com.example.pushwoosh`）。

###### 5. 添加功能

要启用推送通知，您需要添加某些功能。

在 `Signing & Capabilities` 部分，添加以下功能：
- `Push Notifications`
- `Background Modes`。添加此功能后，选中 `Remote notifications` 复选框。

###### 6. 设置 API Token

在 Xcode 中打开 `ios/App/App/Info.plist`，并使用您的 [Pushwoosh Device API Token](/zh/developer/api-reference/api-access-token/#device-api-token) 添加以下条目：

```xml title="Info.plist"
<key>Pushwoosh_API_TOKEN</key>
<string>__YOUR_PUSHWOOSH_DEVICE_API_TOKEN__</string>
```

### Android

###### 1. 将 Capacitor 同步到 Android

将 Capacitor 配置同步到 Android 平台：

```bash
npx cap sync android
```

###### 2. 设置 google-services.json

将您的 `google-services.json` 文件复制到 **android/app** 目录。

###### 3. 设置包名

打开 **android/app/build.gradle** 并将 **applicationId** 设置为您的应用包名（例如，`com.example.pushwoosh`）。

###### 4. 设置 API Token

打开您的 **android/app/src/main/AndroidManifest.xml** 文件，并在 `<application>` 标签内添加以下元数据：

```xml title="AndroidManifest.xml"
<meta-data android:name="com.pushwoosh.apitoken" android:value="__YOUR_PUSHWOOSH_DEVICE_API_TOKEN__" />
```
将 `__YOUR_PUSHWOOSH_DEVICE_API_TOKEN__` 替换为您的 [Pushwoosh Device API Token](/zh/developer/api-reference/api-access-token/#device-api-token)。

###### 5. 打开 Android 项目

在 Android Studio 中打开项目：

```bash
npx cap open android
```

## 运行项目

1. 构建并运行项目。
2. 点击 **"Click Me!"** 按钮。
3. 授予推送通知权限。设备将在 Pushwoosh 注册。

## 发送推送通知

返回 Pushwoosh Control Panel 并向您注册的设备[发送推送通知](/zh/product/messaging-channels/push-notifications/send-push-notifications/one-time-push)。