Быстрый старт с Capacitor SDK

Начните работу с Pushwoosh Capacitor SDK, используя этот быстрый и простой пример.

Предварительные требования

Для интеграции Pushwoosh Capacitor SDK в ваше приложение вам потребуется следующее:

Требования

• Аккаунт Pushwoosh.
• Проект Pushwoosh, настроенный в вашем аккаунте.
• Для интеграции с iOS:
  • Платформа iOS, настроенная для отправки push-уведомлений. Мы рекомендуем использовать конфигурацию на основе токенов (Token-Based Authentication) как самый простой подход.
  • Во время настройки установите Gateway в значение Sandbox, чтобы отправлять пуши на симулятор.
• Для интеграции с Android:
  • Настроенная платформа Android
  • project number (также известный как Sender ID), файл google-services.json и package name из вашего проекта Firebase.
  • Проект Firebase, подключенный к вашему Android-приложению. При необходимости следуйте руководству по настройке Firebase.
• Ваш Pushwoosh Application Code и Pushwoosh Device API Token из Pushwoosh Control Panel для вашего приложения.

Загрузка примера проекта

Клонируйте репозиторий SDK:

git clone https://github.com/Pushwoosh/pushwoosh-capacitor-plugin.git

Перейдите в директорию плагина:

cd pushwoosh-capacitor-plugin

Сборка плагина

Перед запуском примера приложения необходимо собрать плагин Capacitor. Установите зависимости плагина:

npm i

Соберите плагин:

npm run build

Настройка примера приложения

Перейдите в директорию примера приложения:

cd example

Установите зависимости приложения:

npm i

Соберите веб-ресурсы:

npm run build

Откройте src/js/example.js и обновите вызов Pushwoosh.onDeviceReady:

Pushwoosh.onDeviceReady({
    projectid: "__YOUR_FCM_SENDER_ID__",
    appid: "__YOUR_APP_CODE__"
});

Где:

__YOUR_APP_CODE__ — это код приложения из Панели управления Pushwoosh. __YOUR_FCM_SENDER_ID__ — это номер проекта Firebase из Firebase Console.

iOS

1. Установите зависимости CocoaPods

Перейдите в директорию платформы iOS и установите зависимости CocoaPods:

cd ios/App
pod install --repo-update
cd ../..

2. Синхронизируйте Capacitor с iOS

После установки CocoaPods синхронизируйте конфигурацию Capacitor:

npx cap sync ios

3. Откройте проект iOS

Откройте проект в Xcode:

npx cap open ios

3. Установите Bundle Identifier

В Xcode установите Bundle Identifier в качестве имени пакета вашего приложения (например, com.example.pushwoosh).

5. Добавьте возможности

Чтобы включить Push Notifications, необходимо добавить определенные возможности.

В разделе Signing & Capabilities добавьте следующие возможности:

• Push Notifications
• Background Modes. После добавления этой возможности установите флажок для Remote notifications.

6. Установите API Token

Откройте ios/App/App/Info.plist в Xcode и добавьте следующую запись с вашим Pushwoosh Device API Token:

Info.plist

<key>Pushwoosh_API_TOKEN</key>
<string>__YOUR_PUSHWOOSH_DEVICE_API_TOKEN__</string>

Android

1. Синхронизируйте Capacitor с Android

Синхронизируйте конфигурацию Capacitor с платформой Android:

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>:

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.

5. Откройте проект Android

Откройте проект в Android Studio:

npx cap open android

Запуск проекта

1. Соберите и запустите проект.
2. Нажмите кнопку “Click Me!”.
3. Предоставьте разрешение на Push Notifications. Устройство будет зарегистрировано в Pushwoosh.

Отправка Push Notifications

Вернитесь в Панель управления Pushwoosh и отправьте Push Notification на ваше зарегистрированное устройство.