### Install Flutter dependencies and iOS pods
Source: https://developers.actito.com/docs/push-implementation/flutter/implementation
Runs the flutter pub get command to install the dependencies specified in the pubspec.yaml file. It also navigates to the iOS directory and runs pod install to install any iOS dependencies.
```shell
flutter pub get; cd ios; pod install
```
--------------------------------
### Actito SDK Implementation Guide
Source: https://developers.actito.com/docs/push-implementation/web/setup
Provides a link to the implementation guide for the Actito SDK, which is essential for setting up push notifications. This guide likely contains detailed instructions and code examples for integrating the SDK into a web application.
```html
You can now follow the [implementation guide](https://developers.actito.com/docs/push-implementation/web/implementation/).
```
--------------------------------
### Install Notificare Web SDK via NPM
Source: https://developers.actito.com/docs/push-implementation/web/implementation
Installs the Notificare Web SDK using npm. This is the first step to integrating the library into your project.
```bash
npm install notificare-web
```
--------------------------------
### Notificare Configuration File Example
Source: https://developers.actito.com/docs/push-implementation/web/implementation
An example of the JSON configuration file required to connect an application to Notificare, containing application key and secret.
```json
{
"applicationKey":"{{ YOUR APPLICATION KEY }}",
"applicationSecret":"{{ YOUR APPLICATION SECRET }}",
}
```
--------------------------------
### Install Dependencies with CocoaPods
Source: https://developers.actito.com/docs/push-implementation/ios/implementation
This command installs the dependencies specified in your Podfile, including the Notificare SDK components. After running this, you should open the `.xcworkspace` file in Xcode.
```bash
pod install
```
--------------------------------
### Actito Troubleshooting and Samples
Source: https://developers.actito.com/docs/push-implementation/web/setup
Offers links to an HTML troubleshooting guide and HTML samples for the Actito SDK. These resources are valuable for developers encountering issues or seeking practical examples of implementation.
```html
You can consult the [HTML troubleshooting guide](https://developers.actito.com/docs/push-implementation/web/2/docs/push-implementation/web/troubleshooting) and [HTML samples](https://github.com/Notificare/notificare-sdk-web/tree/main/apps/sample-next)
```
--------------------------------
### Install Notificare using 'latest' CDN placeholder
Source: https://developers.actito.com/docs/push-implementation/web/implementation
Shows how to import a Notificare module using the 'latest' placeholder for the version, ensuring the most up-to-date library is used.
```javascript
import{} from 'https://cdn.notifica.re/libs/web/v4/latest/notificare-core.js';
```
--------------------------------
### Launch Notificare SDK
Source: https://developers.actito.com/docs/push-implementation/web/implementation
Demonstrates the basic usage of the `launch()` function to initialize the Notificare SDK within a web application.
```javascript
import{ launch } from 'notificare-web/core';
// Launch Notificare! 🚀
await launch();
```
--------------------------------
### Install Cordova Push Notification Plugins
Source: https://developers.actito.com/docs/push-implementation/cordova/implementation
Installs the core Actito Cordova plugin and optional modules for inbox and push UI functionalities. Requires Cordova 9+.
```cordova
cordova plugin add cordova-plugin-notificare
cordova plugin add cordova-plugin-notificare-inbox
cordova plugin add cordova-plugin-notificare-push
cordova plugin add cordova-plugin-notificare-push-ui
```
--------------------------------
### Install Notificare .NET SDK Packages
Source: https://developers.actito.com/docs/push-implementation/net-maui/implementation
Installs the core Notificare SDK and optional modules for Inbox and Push notifications using the .NET CLI. Ensure you have the latest .NET SDK installed.
```bash
dotnet add package Notificare
dotnet add package Notificare.Inbox
dotnet add package Notificare.Push
dotnet add package Notificare.PushUI
```
--------------------------------
### Android Translucent Theme Example
Source: https://developers.actito.com/docs/push-implementation/cordova/implementation
This XML code provides an example of a translucent theme (`Theme.App.Translucent`) for Android. It sets the window to be translucent and uses a transparent background, suitable for overlaying UI elements.
```xml
```
--------------------------------
### Notificare SDK Configuration File Example
Source: https://developers.actito.com/docs/push-implementation/android/implementation
An example JSON structure for the Notificare SDK configuration file, containing project information such as application ID, key, and secret. This file is essential for connecting the app to Notificare.
```json
{
"project_info":{
"application_id":"{{ YOUR APPLICATION ID }}",
"application_key":"{{ YOUR APPLICATION KEY }}",
"application_secret":"{{ YOUR APPLICATION SECRET }}"
}
}
```
--------------------------------
### Install Notificare Packages via CDN
Source: https://developers.actito.com/docs/push-implementation/web/implementation
Demonstrates how to include Notificare CSS and JavaScript modules in an HTML document using CDN links. It shows importing various Notificare core and feature modules.
```html
```
--------------------------------
### Add Swift Package Manager Dependency
Source: https://developers.actito.com/docs/push-implementation/ios/implementation
Instructions for adding the Notificare iOS SDK to your project using Swift Package Manager.
```text
https://github.com/Notificare/notificare-sdk-ios.git
```
--------------------------------
### Install React Native Notificare SDK
Source: https://developers.actito.com/docs/push-implementation/react-native/implementation
Installs the core React Native Notificare library and optional modules for inbox and push UI functionalities. Ensure you have the latest React Native SDK for compatibility.
```javascript
npm i react-native-notificare
# Optional modules
npm i react-native-notificare-inbox
npm i react-native-notificare-push
npm i react-native-notificare-push-ui
```
--------------------------------
### Handle Notificare SDK Readiness with onReady
Source: https://developers.actito.com/docs/push-implementation/web/implementation
Shows how to use the `onReady()` event to ensure the Notificare SDK is fully initialized and safe to use before executing application logic.
```javascript
import{ onReady } from 'notificare-web/core';
onReady((application)=>{
// Notificare is now safe to use.
});
```
--------------------------------
### Gradle Plugin Configuration
Source: https://developers.actito.com/docs/push-implementation/flutter/implementation
Configuration for the Notificare Gradle plugin in the root and app build.gradle files.
```gradle
//
// root build.gradle
//
buildscript {
repositories {
maven { url 'https://maven.notifica.re/releases' }
}
dependencies {
classpath 're.notifica.gradle:notificare-services:1.0.1'
}
}
allprojects {
repositories {
maven { url 'https://maven.notifica.re/releases' }
maven { url 'https://developer.huawei.com/repo' }
}
}
//
// app build.gradle
//
apply plugin: 're.notifica.gradle.notificare-services'
```
--------------------------------
### Android Service Configuration File
Source: https://developers.actito.com/docs/push-implementation/cordova/implementation
This is an example of the `notificare-services.json` file required for Android. It contains essential project information such as application ID, key, and secret, which are necessary for connecting to the Notificare service.
```json
{
"project_info":{
"application_id":"{{ YOUR APPLICATION ID }}",
"application_key":"{{ YOUR APPLICATION KEY }}",
"application_secret":"{{ YOUR APPLICATION SECRET }}"
}
}
```
--------------------------------
### Launch Notificare in Flutter
Source: https://developers.actito.com/docs/push-implementation/flutter/implementation
Demonstrates how to launch the Notificare SDK within a Flutter application's initialization phase. It ensures Notificare is ready before proceeding.
```dart
class _MyAppState extends State{
@override
void initState(){
super.initState();
_setupNotificare();
}
void _setupNotificare() async{
// Launch Notificare! 🚀
await Notificare.launch();
}
}
```
--------------------------------
### Install Actito Ionic Native Dependencies
Source: https://developers.actito.com/docs/push-implementation/ionic-native/implementation
Installs the core Actito Ionic Native library and optional modules for enhanced functionality. The core library is required, while modules like inbox, push, and push UI can be included based on your app's needs.
```bash
# Required
npm i capacitor-notificare
# Optional modules
npm i capacitor-notificare-inbox
npm i capacitor-notificare-push
npm i capacitor-notificare-push-ui
```
--------------------------------
### CocoaPods Dependencies for Notificare
Source: https://developers.actito.com/docs/push-implementation/ios/implementation
This snippet shows how to add Notificare's core and UI kits as dependencies to your iOS project using CocoaPods. Ensure you run `pod install` after adding these lines to your Podfile.
```ruby
pod 'Notificare/NotificareInboxKit'
pod 'Notificare/NotificarePushKit'
pod 'Notificare/NotificarePushUIKit'
```
--------------------------------
### Listen to Notificare Events in Flutter
Source: https://developers.actito.com/docs/push-implementation/flutter/implementation
Shows how to subscribe to Notificare events like `onReady` and `onDeviceRegistered` to manage application state and respond to SDK status changes.
```dart
void _setupNotificare() async{
Notificare.onReady.listen((application){
// At this point you have been assigned a temporary device identifier.
// Notificare is now safe to use.
});
Notificare.onDeviceRegistered.listen((device){
// At this point you know a device is registered with the Notificare API.
// This method will be called once when the device is registered.
});
// More code ...
}
```
--------------------------------
### Android Push Library Integration
Source: https://developers.actito.com/docs/push-implementation/android/implementation
This snippet details the requirements and resources for integrating the Actito Android push notification library. It supports Android versions 6 and up and recommends using the latest Android SDK. Links to a sample application and source code for a demo app are provided for practical examples.
```java
/*
* Actito Android Push Library Integration Guide
*
* Requirements:
* - Android version 6 and up.
* - Latest Android SDK.
*
* Resources:
* - Sample Application: https://github.com/Notificare/notificare-sdk-android/tree/main/sample
* - Demo App Source Code: https://github.com/Notificare/notificare-go-android
* - Migration Guide: https://github.com/Notificare/notificare-sdk-react-native/blob/main/MIGRATION.md
*/
// Example of how you might initialize the library (actual implementation may vary)
// import com.notificare.Notificare;
// Notificare.shared().start(context);
```
--------------------------------
### Add CocoaPods Dependency
Source: https://developers.actito.com/docs/push-implementation/ios/implementation
Instructions for adding the Notificare iOS SDK to your project using CocoaPods.
```ruby
# Required
pod 'Notificare/NotificareKit'
```
--------------------------------
### iOS Service Configuration File (Plist)
Source: https://developers.actito.com/docs/push-implementation/cordova/implementation
This is an example of the `NotificareServices.plist` file for iOS integration. It holds the application's ID, key, and secret, formatted as an XML Property List, which is standard for iOS configurations.
```xml
APPLICATION_ID{{ YOUR APPLICATION ID }}APPLICATION_KEY{{ YOUR APPLICATION KEY }}APPLICATION_SECRET{{ YOUR APPLICATION SECRET }}
```
--------------------------------
### Launch Notificare SDK
Source: https://developers.actito.com/docs/push-implementation/net-maui/implementation
Demonstrates how to launch the Notificare SDK asynchronously during application initialization. It includes basic error handling for the launch process. Ensure this is called early in the application lifecycle.
```csharp
public partial class App : Application
{
public App()
{
InitializeComponent();
Task.Run(async () =>
{
try
{
await Notificare.LaunchAsync();
}
catch (Exception e)
{
Console.WriteLine($"Failed to launch Notificare: {e.Message}");
}
});
}
}
```
--------------------------------
### Launch Notificare SDK
Source: https://developers.actito.com/docs/push-implementation/android/implementation
Demonstrates how to launch the Notificare SDK in an Android application's main entry point. Includes setting a custom intent receiver and handling the launch process asynchronously.
```kotlin
class MainApplication:Application(){
private val applicationScope = MainScope()
override fun onCreate(){
super.onCreate()
// In case you want to setup your custom intent receiver.
Notificare.intentReceiver = CustomIntentReceiver::class.java
applicationScope.launch {
try{
// Launch Notificare! 🚀
Notificare.launch()
// Notificare is now ready.
}catch(e:Exception){
// Something went wrong ...
}
}
}
}
```
--------------------------------
### iOS Configuration File
Source: https://developers.actito.com/docs/push-implementation/flutter/implementation
The XML configuration file (plist) for iOS, containing application ID, key, and secret.
```xml
APPLICATION_ID{{YOURAPPLICATIONID}}APPLICATION_KEY{{YOURAPPLICATIONKEY}}APPLICATION_SECRET{{YOURAPPLICATIONSECRET}}
```
--------------------------------
### Android Configuration File
Source: https://developers.actito.com/docs/push-implementation/flutter/implementation
The JSON configuration file for Android, containing application ID, key, and secret.
```json
{
"project_info":{
"application_id":"{{ YOUR APPLICATION ID }}",
"application_key":"{{ YOUR APPLICATION KEY }}",
"application_secret":"{{ YOUR APPLICATION SECRET }}"
}
}
```
--------------------------------
### Gradle Dependencies for Notificare SDK
Source: https://developers.actito.com/docs/push-implementation/android/implementation
Configures the project-level build.gradle file to include the Notificare Maven repository and the Notificare Services Gradle Plugin.
```gradle
buildscript {
repositories {
maven { url 'https://maven.notifica.re/releases'}
}
dependencies {
classpath 're.notifica.gradle:notificare-services:1.0.1'
}
}
allprojects {
repositories {
maven { url 'https://maven.notifica.re/releases'}
// Include the pre-releases repository to access beta builds.
maven { url 'https://maven.notifica.re/prereleases'}
}
}
```
--------------------------------
### Android Configuration File
Source: https://developers.actito.com/docs/push-implementation/react-native/implementation
The `notificare-services.json` file for Android contains essential application credentials for connecting to Notificare. Ensure the `application_id`, `application_key`, and `application_secret` are correctly populated.
```json
{
"project_info":{
"application_id":"{{ YOUR APPLICATION ID }}",
"application_key":"{{ YOUR APPLICATION KEY }}",
"application_secret":"{{ YOUR APPLICATION SECRET }}"
}
}
```
--------------------------------
### Listen to Notificare Events
Source: https://developers.actito.com/docs/push-implementation/net-maui/implementation
Shows how to subscribe to Notificare's `Ready` and `DeviceRegistered` events. These events allow for executing custom logic when Notificare is initialized or when a device is successfully registered with the Notificare API.
```csharp
Notificare.Ready += (sender, args) =>
{
// At this point you have been assigned a temporary device identifier.
// Notificare is now safe to use.
};
Notificare.DeviceRegistered += (sender, args) =>
{
// At this point you know a device is registered with the Notificare API.
// This method will be called once when the device is registered.
};
```
--------------------------------
### Platform Setup Versions
Source: https://developers.actito.com/docs/push-implementation/introduction
Lists the latest available versions for Actito SDKs across different platforms and frameworks, ensuring users can implement the most up-to-date functionality.
```APIDOC
Platform/Framework | Latest version
---|---
[Android](https://developers.actito.com/docs/push-implementation/android/setup) | 4.2.0
[iOS](https://developers.actito.com/docs/push-implementation/ios/setup) | 4.2.2
[Web](https://developers.actito.com/docs/push-implementation/web/setup) | 4.2.0
[Flutter](https://developers.actito.com/docs/push-implementation/flutter/setup) | 4.2.2
[React Native](https://developers.actito.com/docs/push-implementation/react-native/setup) | 4.2.2
[Expo](https://developers.actito.com/docs/push-implementation/expo/setup) | 4.2.2
[.NET MAUI](https://developers.actito.com/docs/push-implementation/net-maui/setup) | 4.2.2
[Ionic Native](https://developers.actito.com/docs/push-implementation/ionic-native/setup) | 4.2.2
[Cordova](https://developers.actito.com/docs/push-implementation/cordova/setup) | 4.2.2
```
--------------------------------
### Import Notificare Web SDK Modules and CSS
Source: https://developers.actito.com/docs/push-implementation/web/implementation
Demonstrates how to import core modules and CSS files from the Notificare Web SDK into your JavaScript project. It shows both direct JavaScript imports and SCSS/CSS imports.
```javascript
import{} from 'notificare-web/core';
import{} from 'notificare-web/inbox';
import{} from 'notificare-web/push';
import{} from 'notificare-web/push-ui';
// CSS files
import'notificare-web/push/push.css';
import'notificare-web/push-ui/push-ui.css';
```
```css
@import "notificare-web/in-app-messaging/in-app-messaging.css";
@import "notificare-web/push/push.css";
@import "notificare-web/push-ui/push-ui.css";
```
--------------------------------
### Actito API Reference
Source: https://developers.actito.com/docs/push-implementation/ionic-native/setup
Links to the Actito API Reference documentation, providing details on available endpoints, methods, and schemas for integrating with the Actito platform.
```APIDOC
API Reference:
Access the comprehensive API Reference documentation for Actito at: https://developers.actito.com/api-reference/menu
```
--------------------------------
### Install Notificare React Native Libraries
Source: https://developers.actito.com/docs/push-implementation/expo/implementation
Installs the required and optional Notificare modules for your Expo React Native project using the Expo package manager. Ensure you have the latest Expo SDK.
```bash
npx expo install react-native-notificare
npx expo install react-native-notificare-inbox
npx expo install react-native-notificare-push
npx expo install react-native-notificare-push-ui
```
--------------------------------
### Actito Developers Portal Navigation
Source: https://developers.actito.com/docs/push-implementation/web/setup
This section provides a structured overview of the Actito Developers Portal, including links to key areas such as push implementation guides, use cases, integration frameworks, API references, and support resources.
```APIDOC
Developers Portal:
Use cases: https://developers.actito.com/docs/use-cases/overview
Integration Framework: https://developers.actito.com/docs/integration-framework/overview
API Reference: https://developers.actito.com/api-reference/menu
Help:
Documentation: https://cdn3.actito.com/fe/actito-documentation/
Support
Actito Status: https://status.actito.com/
More:
Corporate: https://www.actito.com
GitHub: https://github.com/actito
```
--------------------------------
### Actito Integration Framework Overview
Source: https://developers.actito.com/docs/push-implementation/flutter/setup
Provides an overview of the Actito Integration Framework, detailing how to integrate external systems and data with the Actito platform.
```APIDOC
Integration Framework:
Learn about integrating with Actito: https://developers.actito.com/docs/integration-framework/overview
```
--------------------------------
### Actito API Reference
Source: https://developers.actito.com/docs/push-implementation/cordova/setup
Links to the comprehensive Actito API Reference documentation, which details available endpoints, methods, and data schemas for integrating with the Actito platform.
```APIDOC
API Reference:
Access the full API documentation at: https://developers.actito.com/api-reference/menu
```
--------------------------------
### Actito API Reference
Source: https://developers.actito.com/docs/push-implementation/flutter/setup
Links to the comprehensive Actito API Reference documentation, covering various endpoints and functionalities for integrating with the Actito platform.
```APIDOC
API Reference:
Access the full API documentation at: https://developers.actito.com/api-reference/menu
```
--------------------------------
### Gradle Plugin Configuration
Source: https://developers.actito.com/docs/push-implementation/ionic-native/implementation
Configuration for the Notificare Gradle plugin in `build.gradle` files to simplify Notificare SDK setup in Android projects. It includes repository and dependency declarations.
```gradle
//
// root build.gradle
//
buildscript {
repositories {
maven { url 'https://maven.notifica.re/releases' }
}
dependencies {
classpath 're.notifica.gradle:notificare-services:1.0.1'
}
}
allprojects {
repositories {
maven { url 'https://maven.notifica.re/releases' }
maven { url 'https://developer.huawei.com/repo' }
}
}
//
// app build.gradle
//
apply plugin: 're.notifica.gradle.notificare-services'
```
--------------------------------
### NotificationActivity Theming for Managed Notifications
Source: https://developers.actito.com/docs/push-implementation/android/implementation
Illustrates how to configure the NotificationActivity in AndroidManifest.xml to use a translucent theme for displaying floating alerts. It also provides an example of a translucent theme style.
```xml
```
```xml
```
--------------------------------
### Actito Use Cases Overview
Source: https://developers.actito.com/docs/push-implementation/flutter/setup
Details various use cases for the Actito platform, illustrating how to leverage its features for marketing automation and customer engagement.
```APIDOC
Use Cases:
Explore Actito use cases: https://developers.actito.com/docs/use-cases/overview
```
--------------------------------
### Get All Entities
Source: https://developers.actito.com/docs/use-cases/quick-start
Retrieves a list of all entities accessible via the Actito API. This is a foundational step as resources are linked to entities. Requires Authorization and Accept headers. Returns a 401 for invalid credentials and 406 for incorrect Accept header.
```APIDOC
GET /entities/v5/entities
Headers:
Authorization: Bearer
Accept: application/json
Response (200 OK):
{
"entities": [
{
"id": ,
"name": "",
"comment": ""
}
]
}
Error Responses:
401 Unauthorized: Invalid or missing credentials.
406 Not Acceptable: Incorrect or unsupported Accept header value.
```
```bash
curl -X GET \
https://api.actito.com/entities/v5/entities \
-H'Accept: application/json' \
-H'Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI0IiwiaWF0IjoxNTg2ODY1MjE1LCJpc3MiOiJhY3RpdG8iLCJleHAiOjE1ODY4NjYxMTUsImxpY2VuY2VJZCI6MTI3NDAsImFjY291bnRJZCI6MTIsInBvbCI6Im1haW5Qb2xpY3lBcGkiLCJzdWIiOiI2ZWY3YjZmYS0wYTc1LTQ1YTYtYmE5My1iZGY5MmUyZjg3NDAifQ.umizXm0TueN6jRkMCaz9AnQP30qNxud5XIxnZiPzz24L8Aon7WKeJ8_49xcjsTe_v13nv4AI9991Mw_k9bvQffT__eikkv9UMmZ22wvQr5UxCH5Y-NkxFRctEGLjmkEdFFe2EuOkF1GjsIetPrJgY-_L6bpoa3G0o69IWavBIFowQtw_q0FOPaZ_JtBLiDiFH59IM5s4-8S-QAhGkGgjOhTzqBTyDBGj8cqnhvr9eFwgoxGSAZ1QLGU5yTRyIJm8Uaq97M5UhKn98ixK4oQhQvVKwW9MDgGyf0jLFLEFO7l9kyFON34OsxiTyK58U_OFJzehgxqRokBE3wXWo9rKEA'
```
--------------------------------
### Actito Platform Overview
Source: https://developers.actito.com/docs/welcome/introduction
Provides a high-level introduction to the Actito Marketing Automation Platform, highlighting its capabilities in managing marketing databases and building multichannel campaigns. It emphasizes customer data unification for personalized marketing activations.
```APIDOC
Actito Platform:
Description: Agile SaaS Marketing Automation Platform.
Capabilities:
- Marketing database management.
- Multichannel campaign building (email, SMS, push, call center, print, web, etc.).
- Customer data unification for a 360° customer view.
- Real-time, personalized, and multichannel marketing activations.
Target Audience: Marketers.
Developer Integration:
Purpose: To understand how to benefit from the Actito Platform.
Prerequisites: Familiarity with fundamental Actito platform concepts.
Resources:
- Actito Concepts: https://developers.actito.com/docs/welcome/concepts
- Actito Website: https://www.actito.com
Coming Soon Features:
Indication: Features marked with 'SOON' may not be available or accessible yet.
Documentation: Provides planned functionality, but protocols and details may change before official release.
```
--------------------------------
### Implement Notificare Listener for Un-launch Event (Java)
Source: https://developers.actito.com/docs/push-implementation/android/implementation
This example demonstrates how to implement the `Notificare.Listener` interface in Java to receive notifications when the Notificare SDK has been un-launched. It includes adding and removing the listener in the activity's lifecycle methods.
```java
publicclassMainActivityextendsAppCompatActivityimplementsNotificare.Listener{
@Override
protectedvoidonCreate(@NullableBundle savedInstanceState){
// more code ...
Notificare.addListener(this);
}
@Override
protectedvoidonDestroy(){
// more code ...
Notificare.removeListener(this);
}
@Override
publicvoidonUnlaunched(){
// All device data was deleted.
// Notificare cannot be used until it's launched again.
}
}
```
--------------------------------
### Implement Notificare Listener for Un-launch Event (Kotlin)
Source: https://developers.actito.com/docs/push-implementation/android/implementation
This example demonstrates how to implement the `Notificare.Listener` interface in Kotlin to receive notifications when the Notificare SDK has been un-launched. It includes adding and removing the listener in the activity's lifecycle methods.
```kotlin
classMainActivity:AppCompatActivity(),Notificare.Listener{
override fun onCreate(savedInstanceState:Bundle?){
// more code ...
Notificare.addListener(this)
}
override fun onDestroy(){
// more code ...
Notificare.removeListener(this)
}
override fun onUnlaunched(){
// All device data was deleted.
// Notificare cannot be used until it's launched again.
}
}
```
--------------------------------
### Actito API Reference Overview
Source: https://developers.actito.com/docs/integration-framework/integrations/overview
Provides access to the Actito API Reference documentation, covering various endpoints and functionalities for integrating with the Actito platform.
```APIDOC
API Reference:
- Access the full API documentation for integrating Actito with external systems.
- Covers endpoints for data management, campaign execution, and more.
- Link: https://developers.actito.com/api-reference/menu
```
--------------------------------
### Custom Intent Receiver Implementation
Source: https://developers.actito.com/docs/push-implementation/android/implementation
Provides Kotlin and Java code examples for creating a custom intent receiver that listens to 'onReady' and 'onDeviceRegistered' events from Notificare. This allows for custom logic execution when Notificare becomes ready or the device registration is updated.
```kotlin
class CustomIntentReceiver : NotificareIntentReceiver() {
override fun onReady(context: Context, application: NotificareApplication) {
// At this point you have been assigned a temporary device identifier
// All services subscribed can be used
}
override fun onDeviceRegistered(context: Context, device: NotificareDevice) {
// At this point you know a device is registered with the Notificare API.
// This method will be called once when the device is registered.
}
}
```
```java
public class CustomIntentReceiver extends NotificareIntentReceiver {
@Override
protected void onReady(@NonNull Context context, @NonNull NotificareApplication application) {
// At this point you have been assigned a temporary device identifier
// All services subscribed can be used
}
@Override
protected void onDeviceRegistered(@NonNull Context context, @NonNull NotificareDevice device) {
// At this point you know a device is registered with the Notificare API.
// This method will be called once when the device is registered.
}
}
```
--------------------------------
### Firebase Cloud Messaging Setup for Android
Source: https://developers.actito.com/docs/push-implementation/react-native/implementation
Instructions for integrating Firebase Cloud Messaging (FCM) into an Android application using Android Studio. This process involves using the Firebase Assistant to add the FCM project and ensures the `google-services.json` file is created, containing essential project information like the Sender ID.
```java
// In Android Studio:
// 1. Go to Tools > Firebase.
// 2. Click 'Set up Firebase Cloud Messaging'.
// 3. Follow the on-screen guides.
// This process will generate an app/google-services.json file.
```
--------------------------------
### Native Troubleshooting Resources
Source: https://developers.actito.com/docs/push-implementation/net-maui/troubleshooting
Provides links to specific troubleshooting guides for the native Android and iOS SDKs, offering more detailed assistance for platform-specific issues encountered during push implementation.
```APIDOC
Native SDK Troubleshooting:
- Android troubleshooting: https://developers.actito.com/docs/push-implementation/android/troubleshooting
- iOS troubleshooting: https://developers.actito.com/docs/push-implementation/ios/troubleshooting
```
--------------------------------
### NotificationActivity Theme
Source: https://developers.actito.com/docs/push-implementation/flutter/implementation
Configuration for the NotificationActivity in Android to display floating alerts.
```xml
```
```xml
```
--------------------------------
### Actito Help and Support Links
Source: https://developers.actito.com/docs/push-implementation/flutter/troubleshooting
Provides links to Actito's documentation, support channels, and system status page.
```en
Documentation: https://cdn3.actito.com/fe/actito-documentation/
Actito Status: https://status.actito.com/
```
--------------------------------
### iOS Push Notification Setup Prerequisites
Source: https://developers.actito.com/docs/push-implementation/ios/setup
Lists the essential requirements for setting up iOS push notifications using the Actito library. This includes having the latest version of Xcode and access to Apple's Developer Portal.
```ios
Prerequisites:
- Latest version of Xcode
- Access to Apple's Developer Portal
```
--------------------------------
### cURL Request to Get Profile Table Structure
Source: https://developers.actito.com/docs/use-cases/quick-start
This cURL command demonstrates how to make a GET request to the Actito API to retrieve the structure of the 'Contacts' profile table within the '_integrationframeworksandbox' entity. It includes necessary headers for authentication and content negotiation.
```bash
curl -X GET \
https://api.actito.com/profile-table-structure/v5/entities/integrationframeworksandbox/profile-tables/Contacts \
-H'Accept: application/json' \
-H'Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI0IiwiaWF0IjoxNTg2ODY1MjE1LCJpc3MiOiJhY3RpdG8iLCJleHAiOjE1ODY4NjYxMTUsImxpY2VuY2VJZCI6MTI3NDAsImFjY291bnRJZCI6MTIsInBvbCI6Im1haW5Qb2xpY3lBcGkiLCJzdWIiOiI2ZWY3YjZmYS0wYTc1LTQ1YTYtYmE5My1iZGY5MmUyZjg3NDAifQ.umizXm0TueN6jRkMCaz9AnQP30qNxud5XIxnZiPzz24L8Aon7WKeJ8_49xcjsTe_v13nv4AI9991Mw_k9bvQffT__eikkv9UMmZ22wvQr5UxCH5Y-NkxFRctEGLjmkEdFFe2EuOkF1GjsIetPrJgY-_L6bpoa3G0o69IWavBIFowQtw_q0FOPaZ_JtBLiDiFH59IM5s4-8S-QAhGkGgjOhTzqBTyDBGj8cqnhvr9eFwgoxGSAZ1QLGU5yTRyIJm8Uaq97M5UhKn98ixK4oQhQvVKwW9MDgGyf0jLFLEFO7l9kyFON34OsxiTyK58U_OFJzehgxqRokBE3wXWo9rKEA'
```
--------------------------------
### Launch Notificare SDK
Source: https://developers.actito.com/docs/push-implementation/android/implementation
Demonstrates how to launch the Notificare SDK in an Android application's main entry point using Java. Includes setting a custom intent receiver and handling the launch process with a callback.
```java
public class MainApplication extends Application{
@Override
public void onCreate(){
super.onCreate();
// In case you want to setup your custom intent receiver.
Notificare.setIntentReceiver(CustomIntentReceiver.class);
// Launch Notificare! 🚀
Notificare.launch(new NotificareCallback(){
@Override
public void onSuccess(Unit result){
// Notificare is now ready.
}
@Override
public void onFailure(@NonNull Exception e){
// Something went wrong ...
}
});
}
}
```
--------------------------------
### Actito Help and Resources
Source: https://developers.actito.com/docs/integration-framework/exports/principle
Provides links to Actito's help resources, including general documentation, support, and system status.
```APIDOC
Actito Help and Resources:
- Documentation: https://cdn3.actito.com/fe/actito-documentation/
- Support: Contact information not provided in snippet.
- Actito Status: https://status.actito.com/
```
--------------------------------
### iOS `NotificareServices.plist` Configuration
Source: https://developers.actito.com/docs/push-implementation/net-maui/implementation
The structure of the `NotificareServices.plist` file for iOS, containing application credentials needed to connect with Notificare.
```plist
APPLICATION_ID{{ YOUR APPLICATION ID }}APPLICATION_KEY{{ YOUR APPLICATION KEY }}APPLICATION_SECRET{{ YOUR APPLICATION SECRET }}
```
--------------------------------
### Android `notificare-services.json` Configuration
Source: https://developers.actito.com/docs/push-implementation/net-maui/implementation
The structure of the `notificare-services.json` file for Android, containing essential application details required for connecting to Notificare.
```json
{
"project_info":{
"application_id":"{{ YOUR APPLICATION ID }}",
"application_key":"{{ YOUR APPLICATION KEY }}",
"application_secret":"{{ YOUR APPLICATION SECRET }}"
}
}
```
--------------------------------
### Actito Integration Framework Overview
Source: https://developers.actito.com/docs/integration-framework/integrations/overview
Details the Actito Integration Framework, which facilitates connections to external tools and platforms. It outlines different integration methods like Webhooks, ETLs, Exports, and File Transfers.
```APIDOC
Integration Framework:
- Overview: https://developers.actito.com/docs/integration-framework/overview
- APIs: https://developers.actito.com/docs/integration-framework/integrations/overview
- Webhooks: https://developers.actito.com/docs/integration-framework/integrations/overview
- ETLs: https://developers.actito.com/docs/integration-framework/integrations/overview
- Exports: https://developers.actito.com/docs/integration-framework/integrations/overview
- File Transfers: https://developers.actito.com/docs/integration-framework/filetransfers/file-transfer
- Integrations: https://developers.actito.com/docs/integration-framework/integrations/overview
```
--------------------------------
### Using onReady Delegate Method for Initialization Control
Source: https://developers.actito.com/docs/push-implementation/ios/implementation
This Swift code snippet shows how to use the `onReady` method from the `NotificareDelegate` protocol. This approach allows for controlling the state of dependencies within your application's initialization flow, ensuring Notificare is ready before proceeding with dependent operations.
```swift
extension AppDelegate: NotificareDelegate {
func notificare(_: Notificare, onReady application: NotificareApplication) {
// Notificare is now safe to use.
}
}
```
--------------------------------
### Android `NotificationActivity` Theme Configuration
Source: https://developers.actito.com/docs/push-implementation/net-maui/implementation
Configures the `NotificationActivity` in the AndroidManifest.xml to use a translucent theme, allowing notifications to display as floating alerts.
```xml
```
--------------------------------
### Creating an App ID on Apple Developer Portal
Source: https://developers.actito.com/docs/push-implementation/ios/setup
Step-by-step instructions for creating an App ID on Apple's Developer Portal. This process involves signing in, navigating to Certificates, IDs & Profiles, creating a new identifier, selecting 'App IDs', providing an app name and reverse DNS identifier, choosing capabilities, and confirming registration.
```APIDOC
API: Apple Developer Portal - App ID Creation
1. Sign in to Apple's Developer Portal.
2. Navigate to 'Certificates, IDs & Profiles'.
3. Select 'Identifiers' from the menu.
4. Click the '+' icon to add a new identifier.
5. Choose 'App IDs' and click 'Continue'.
6. Provide an 'App Name' and an 'Identifier' in reverse DNS format (e.g., com.mydomain.myapp).
7. Select the necessary capabilities for your app (e.g., Push Notifications).
8. Click 'Continue' to review the selections.
9. Click 'Register' to finalize the App ID creation.
10. Verify the newly created App ID in the list of identifiers.
```
--------------------------------
### iOS Configuration File
Source: https://developers.actito.com/docs/push-implementation/ionic-native/implementation
The `NotificareServices.plist` file for iOS, formatted in XML, contains the application ID, key, and secret necessary for Notificare integration.
```xml
APPLICATION_ID{{ YOUR APPLICATION ID }}APPLICATION_KEY{{ YOUR APPLICATION KEY }}APPLICATION_SECRET{{ YOUR APPLICATION SECRET }}
```
--------------------------------
### Un-launch Notificare in Flutter
Source: https://developers.actito.com/docs/push-implementation/flutter/implementation
Provides the method to completely remove all Notificare data for a device, both locally and remotely. It also covers listening to the `onUnlaunched` event.
```dart
await Notificare.unlaunch()
Notificare.onUnlaunched.listen((application){
// All device data was deleted.
// Notificare cannot be used until it's launched again.
});
```
--------------------------------
### Actito Push Notification Features
Source: https://developers.actito.com/docs/push-implementation/web/setup
Lists the supported features for Actito push notifications, including device registration and remote notification handling. It also mentions unsupported features and provides links to external resources for troubleshooting and sample code.
```html
Device Registration
* Register as a user
* Override Device Language
Remote Notifications
* Requesting Permission
* Enabling Notifications
* Disabling remote notifications
* Receiving Notifications
Inbox
```
--------------------------------
### React Native Push Setup Prerequisites
Source: https://developers.actito.com/docs/push-implementation/react-native/setup
Lists the essential software and access required to implement push notifications in a React Native application using the Actito library. This includes development tools and developer portal access.
```text
Prerequisites:
- The latest version of Android Studio
- The latest version of Xcode
- Access to the Apple's Developer Portal
```
--------------------------------
### Launching Notificare
Source: https://developers.actito.com/docs/push-implementation/react-native/implementation
Initializes the Notificare service within your React Native application. It's recommended to call this during application initialization. The launch process is asynchronous.
```javascript
class _MyAppState extends State{
@override
void initState(){
super.initState();
_setupNotificare();
}
void _setupNotificare()async{
// Launch Notificare! 🚀
await Notificare.launch();
}
}
```
--------------------------------
### iOS Configuration File
Source: https://developers.actito.com/docs/push-implementation/react-native/implementation
The `NotificareServices.plist` file for iOS stores the application credentials. This XML-based property list file should contain the `APPLICATION_ID`, `APPLICATION_KEY`, and `APPLICATION_SECRET`.
```xml
APPLICATION_ID{{YOURAPPLICATIONID}}APPLICATION_KEY{{YOURAPPLICATIONKEY}}APPLICATION_SECRET{{YOURAPPLICATIONSECRET}}
```