Bitespeed React Native SDK

© Bitespeed

This SDK is designed for React Native applications to facilitate tracking of user events, product interactions, and notifications. It ensures accurate identification of users and provides seamless integration with the Bitespeed API.

Features

• User Identification: Identify users with contact details (email/phone).
• Notification Tracking: Track notification events like delivery and clicks.
• Product Event Tracking: Track events such as product views and add-to-cart.

Setup Instructions

1. Install the Bitespeed SDK

   To integrate the Bitespeed SDK into your React Native project:

    npm install @bitespeed/react-native-sdk

2. Set Up Firebase for FCM (Push Notifications)

   To setup firebase for react-native, follow the instructions here for both Android and iOS.

3. Set up Firebase Cloud Messaging (FCM) for Push Notifications

   To set up FCM, follow the official Firebase documentation here.

4. Add FCM Receiving Message Handlers

   Add the following code to your App.js file to receive FCM messages:

   import messaging from '@react-native-firebase/messaging'
   
   messaging().onMessage(async (remoteMessage) => {
     // call the trackNotification method here
   })
   
   messaging().setBackgroundMessageHandler(async (remoteMessage) => {
     // call the trackNotification method here
   })

   Refer to the official Firebase documentation here for more details.

Important Notes:

1. Make sure to add the google-services.json file to your android project and GoogleService-Info.plist to your iOS project.
2. Both Android and iOS require additional setup for FCM. Refer to the official Firebase documentation for more details.
3. Ask the user for permission to receive push notifications.
4. Make sure to call the trackNotification method in the onMessage and setBackgroundMessageHandler handlers to track notification events.

Usage

1. Initialize the SDK

   Initialize the SDK with your API key and shop URL:

   import BitespeedSDK from 'bitespeed-sdk'
   
   const sdk = BitespeedSDK.getInstance('<SHOP_URL>.myshopify.com', 'your-api-key')

2. Identify User

   Identify the user with their details and FCM token:

   await sdk.identify(
     {
       email: '[email protected]',
       phone: '1234567890',
       firstName: 'John',
       lastName: 'Doe',
     },
     'fcm-token' // Here you can pass the FCM token
   )

3. Track Product Events

   Track product-related events such as viewing or adding to the cart:

   await sdk.trackProductEvent('productView', {
     event: {
       id: 'prod-123',
       name: 'Sample Product',
       price: 100,
       handle: 'sample-product',
     },
   })

4. Track Notification Events

   Track notification events like clicks or delivery:

   await sdk.trackNotification('clicked', 'notif-123')

Supported Events

1. Product Events:

   • productView - when the user views a product.
   • addToCart - when the user adds a product to the cart.

2. Notification Events:

   • delivered - when the notification is delivered to the user.
   • clicked - when the user clicks on a notification.

Error Handling

The SDK will throw errors if:

• API key or shop URL is missing during initialization.
• User is not identified before tracking events.
• Unsupported events are passed to tracking methods.

Contact

For further assistance, reach out to Bitespeed Support at [email protected].