react-native-zalo-kit

Zalo SDK for React Native

Table of Contents

1. Installation
2. Supported APIs
3. Setup
   1. Create Zalo Application
   2. iOS setup
   3. Android setup
4. Usage
5. Troubleshooting
6. Demo

Installation

With npm: $ npm install react-native-zalo-kit --save

With yarn: $ yarn add react-native-zalo-kit

Supported APIs

Zalo has stopped suporting some APIs, which will throw Application is not registered for this request error when calling. Check here for details.

Below is list of supported APIs:

• [x] Login
• [x] isAuthenticated
• [x] getUserProfile
• [x] logout
• [ ] getUserFriendList
• [ ] getUserInvitableFriendList
• [ ] postFeed
• [ ] sendMessageToFriend
• [ ] inviteFriendUseApp
• [x] sendMessageByApp
• [x] postFeedByApp
• [x] register

Setup

Create Zalo Application

First of all you need to create Zalo application on Zalo Developer Portal

Note: when setting up Android platform for your application, it'll ask you for a Hash key. We provide you a helper function to get that key

Next, go to Sản phẩm>Đăng nhập and configure for Android and iOS:

Enter your app package name, hash key, and bundle ID

After that you'll get your Zalo App Key, and you'll need to use it for next sections

Note 1: you're recommended to turn your Zalo app to Live Mode in order to get full functionalities.

React Native CLI Project

iOS

Run the following command to setup for iOS:

npx pod-install ios

After that, open ios/<your_app_name>/AppDelegate.mm, and add the following:

#import <ZaloSDK/ZaloSDK.h>

- (BOOL)application:(UIApplication *)application
 didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    ...

    [[ZaloSDK sharedInstance] initializeWithAppId:@"<YOUR_ZALO_APP_ID>"];
    
    return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

...  

- (BOOL)application:(UIApplication *)application openURL:(nonnull NSURL *)url options:(nonnull NSDictionary<NSString *,id> *)options {
  return [[ZDKApplicationDelegate sharedInstance] application:application openURL:url options:options];
}

Example AppDelegate.mm

#import "AppDelegate.h"
#import <React/RCTBundleURLProvider.h>
#import <ZaloSDK/ZaloSDK.h>

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  self.moduleName = @"TestZaloKit";
  // You can add your custom initial props in the dictionary below.
  // They will be passed down to the ViewController used by React Native.
  self.initialProps = @{};
  
  [[ZaloSDK sharedInstance] initializeWithAppId:@"ZALO_APP_ID"];

  return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

- (BOOL)application:(UIApplication *)application openURL:(nonnull NSURL *)url options:(nonnull NSDictionary<NSString *,id> *)options {
  return [[ZDKApplicationDelegate sharedInstance] application:application openURL:url options:options];
}

- (NSURL *)sourceURLForBridge:(RCTBridge *)bridge
{
#if DEBUG
  return [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index"];
#else
  return [[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"];
#endif
}

@end

Next, Open your app in Xcode (you have to use .xcworkspace file) -> Select your project under Targets -> select tab Info, select the last line and click +:

Then key in LSApplicationQueriesSchemes:

After that hit Enter, it'll automatically change key name to Queried URL Schemes (type Array), then insert 2 items with value zalosdk and zaloshareext like below:

Next, still under tab Info -> URL Types -> Click + to add new with identifier zalo and URL Schemes is zalo-your_app_id

Android

1. Open android/build.gradle, and check the minSdkVersion if it's < 18 then make it 18 otherwise leave default:

buildscript {
    ext {
      ...

      minSdkVersion = 18
    }

    ...

2. Open android/app/src/main/java/<your_app_package>/MainActivity.(java|kt), and add the following:

Java

import com.zing.zalo.zalosdk.oauth.ZaloSDK;
import android.content.Intent;

public class MainActivity extends ReactActivity {
  ...

  // override method below (create it if not exist)
  @Override
  public void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    ZaloSDK.Instance.onActivityResult(this, requestCode, resultCode, data);
  }
}

Kotlin

import com.zing.zalo.zalosdk.oauth.ZaloSDK;
import android.content.Intent;

class MainActivity : ReactActivity() {
  ...

  // override method below (create it if not exist)
  override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)
    ZaloSDK.Instance.onActivityResult(this, requestCode, resultCode, data)
  }
}

3. After that, open android/app/src/main/java/<your_app_package>/MainApplication.(java|kt), and add the following:

Java

import com.zing.zalo.zalosdk.oauth.ZaloSDKApplication;

public class MainApplication extends Application implements ReactApplication {
  ...

  @Override
  public void onCreate() {
    ...

    ZaloSDKApplication.wrap(this);
  }
}

Kotlin

import com.zing.zalo.zalosdk.oauth.ZaloSDKApplication;

class MainApplication : Application(), ReactApplication {
  ...

  override fun onCreate() {
    ...
    ZaloSDKApplication.wrap(this);
  }
}

4. Add appID to android/app/src/main/res/values/strings.xml

<resources>
    <string name="app_name">App Name</string>
    <string name="appID"><YOUR_ZALO_APP_ID></string>
</res>

5. Add the following to android/app/src/main/AndroidManifest.xml :

<application>

  ...

  <meta-data
    android:name="com.zing.zalo.zalosdk.appID"
    android:value="@string/appID" />

  <activity
    android:name="com.zing.zalo.zalosdk.oauth.BrowserLoginActivity"
    android:exported="true"  
  >
    <intent-filter>
      <action android:name="android.intent.action.VIEW" />
      <category android:name="android.intent.category.DEFAULT" />
      <category android:name="android.intent.category.BROWSABLE" />
      <data android:scheme="zalo-<YOUR_ZALO_APP_ID>" />
      <!-- eg: <data android:scheme="zalo-1234567890" />-->
    </intent-filter>
  </activity>
</application>

<queries>
  <package android:name="com.zing.zalo" />
</queries>

6. In android/app/src/proguard-rules.pro add the following:

-keep class com.zing.zalo.**{ *; }
-keep enum com.zing.zalo.**{ *; }
-keep interface com.zing.zalo.**{ *; }

Expo project (managed workflow)

Expand to view

If you're using app.json then you need to change to use app.config.js. For example:

// app.config.js

module.exports = { /* content of your app.json */}

Next to in order to safely update AppDelete, MainActivity and MainApplication so that it won't conflict with other plugins, we'll log the content of them out, then add custom code. Finally pass content of the files as strings to Zalo Kit Expo plugin.

First in your app.config.js > plugins, let's log content of AppDelete, MainActivity and MainApplication.

module.exports = {
  expo: {
    // ...other configs
    plugins: [
      ['react-native-zalo-kit/expo/withAppDelegateDebug'],
      ['react-native-zalo-kit/expo/withMainActivityDebug'],
      ['react-native-zalo-kit/expo/withMainApplicationDebug']
    ],
  },
};

Now run:

npx expo prebuild --clean

You'll see actual content of the 3 files in console, copy each of them and store in a single file name zalokitStrings.js at root folder project, then you do update each file exactly same as with RN CLI project (remember to update the zalo app ID in AppDelegate)

The final structure should look like this:

const appDelegateContent = `<content>`
const mainActivityContent = `<content>`
const mainApplicationContent = `<content>`

module.exports = {
  appDelegateContent,
  mainActivityContent,
  mainApplicationContent
};

Next, import those content into app.config.js

const {
  appDelegateContent,
  mainActivityContent,
  mainApplicationContent,
} = require("./zalokitStrings");

module.exports = {
  expo: {
    // other configs
    plugins: [
      [
        "expo-build-properties", // remember to install this package
        {
          android: {
            extraProguardRules: `
              -keep class com.zing.zalo.**{ *; }
              -keep enum com.zing.zalo.**{ *; }
              -keep interface com.zing.zalo.**{ *; }
            `,
          },
        },
      ],
      [
        "react-native-zalo-kit/expo",
        {
          appId: "2451745039837416278",
          appDelegateContent,
          mainActivityContent,
          mainApplicationContent,
        },
      ],
    ],
  },
};

Finally, run prebuild again:

npx expo prebuild --clean

And you should get a fully configured Expo project with ZaloKit. You can view examples at: app.config.js and zalokitStrings.js

Usage

You can import the whole library like:

import ZaloKit from 'react-native-zalo-kit'

// Usage:
ZaloKit.login()
...

Or you can just import modules you need like:

import { login } from 'react-native-zalo-kit'

// Usage
login()

Login

import { login, Constants } from 'react-native-zalo-kit'

const login = async () => {
  try {
    const oauthCode = await login(Constants.AUTH_VIA_APP_OR_WEB)
    console.log(oauthCode)

    /*
      returns: {
        accessToken: "some value"
        refreshToken: "some value"
      }
    */
  } catch (error) {
    console.log(error)
  }
}

login supports the following methods:

• AUTH_VIA_APP_OR_WEB: login via app or web. If user has Zalo app then login with app, otherwise using web
• AUTH_VIA_APP: login using Zalo app only
• AUTH_VIA_WEB: login using Zalo web only

Check if authenticated

import { isAuthenticated } from 'react-native-zalo-kit'

const isAuthenticated = async () => {
  try {
    const isAuthenticated = await isAuthenticated()
    console.log(isAuthenticated)

    /*
      returns: true | false
    */
  } catch (error) {
    console.log(error)
  }
}

Get User Profile

import { getUserProfile } from 'react-native-zalo-kit'

const getUserProfile = async () => {
  try {
    const userProfile = await getUserProfile()
    console.log(userProfile)

    /*
      returns: {
        id: 'user_id_1',
        name: 'user name',
        phoneNumber: 'phone number',
        gender: 'male',
        birthday: '01/01/2020',
        picture: {
          data: {
            url: 'http://image.example',
          },
        }
      }
    */
  } catch (error) {
    console.log(error)
  }
}

Logout

import { logout } from 'react-native-zalo-kit'

const logout = () => {
  logout()
}

Get Application Hash Key (Android only)

This is a helper function which returns app Hash key for Android, help you on setting up your app on Zalo Developer Portal

import { getApplicationHashKey } from 'react-native-zalo-kit'

const getApplicationHashKey = () => {
  const key = getApplicationHashKey()
  console.log(key)

  /*
    returns: 'application hash key'
  */
}

Get friend list used app

This API is to get friends who have used Zalo app

import { getUserFriendList } from 'react-native-zalo-kit'

const getUserFriendList = async () => {
  try {
    const offset = 0 // offset we start from
    const count = 10 // number of records per page
    const friends = await getUserFriendList(offset, count)
    console.log(friends)

    /*
      returns: {
        data: [
          {
            id: 'user_id_1',
            name: 'user name',
            phoneNumber: 'phone number',
            gender: 'male',
            birthday: '01/01/2020',
            picture: {
              data: {
                url: 'http://image.example',
              },
            }
          }
        ],
        paging: {},
        summary: {
          total_count: number,
        }
      }
    */
  } catch (error) {
    console.log(error)
  }
}

Get invitable friend list

This API is to get friends who we can invite to use Zalo app

import { getUserInvitableFriendList } from 'react-native-zalo-kit'

const getUserInvitableFriendList = async () => {
  try {
    const offset = 0 // offset we start from
    const count = 10 // number of records per page
    const friends = await getUserInvitableFriendList(offset, count)
    console.log(friends)

    /*
      returns: {
        data: [
          {
            id: 'user_id_1',
            name: 'user name',
            phoneNumber: 'phone number',
            gender: 'male',
            birthday: '01/01/2020',
            picture: {
              data: {
                url: 'http://image.example',
              },
            }
          }
        ],
        paging: {},
        summary: {
          total_count: number,
        }
      }
    */
  } catch (error) {
    console.log(error)
  }
}

Post to user's feed

import { postFeed } from 'react-native-zalo-kit'

const postFeed = async () => {
  try {
    const link = 'https://zing.vn'
    const message = 'Hello World'
    const data = await postFeed(message, link)
    console.log(data)
    
    /*
      returns: {
        id: 'post_id'
      }
    */
  } catch (error) {
    console.log(error.message)
  }
}

Send message to friend

import { sendMessage } from 'react-native-zalo-kit'

const sendMessage = async () => {
  try {
    const friendId = 'friend_ID'
    const link = 'https://zing.vn'
    const message = 'Hello World'
    const data = await sendMessage(friendId, message, link)
    console.log(data)

    /*
      returns: {
        to: 'friend_ID'
      }
    */
  } catch (error) {
    console.log(error)
  }
}

Invite friend to use Zalo app

import { inviteFriendUseApp } from 'react-native-zalo-kit'

const inviteFriendUseApp = async () => {
  try {
    const friendIds = ['friend_ID1', 'friend_ID2']
    const message = 'Hello World'
    const data = await inviteFriendUseApp(friendIds, message)
    console.log(data)

    /*
      returns: {
        to: [
          'friend_ID1', 'friend_ID2'
        ]
      }
    */
  } catch (error) {
    console.log(error)
  }
}

Send message by app

This API is to share a link to a friend by sending a message which contains the link

import { sendMessageByApp } from 'react-native-zalo-kit'

const sendMessageByApp = async () => {
  try {
    const feedData = {
      appName: 'DEMO RN APP',
      message: 'Hello World',
      link: 'https://zing.vn',
      linkTitle: 'LINK TITLE',
      linkSource: 'LINK SOURCE',
      linkDesc: 'LINK DESC',
      linkThumb: ['https://lh3.googleusercontent.com/dr8A58cYr-Mnz6mi5QCe6_I2yaCICVV0jL7fjrzWixn89HiA4BGW-KraR7yU4JappTs'],
      others: {}
    }

    const data = await sendMessageByApp(feedData)
    console.log(data)

    /*
      returns: {
        success: true,
        data: "<raw message>",
        message: "format message",
        sendAction: 0 or 1 (0: sent, 1: cancelled)
      }
    */
  } catch (error) {
    console.log(error)
  }
}

Post to feed by app

This API is to share a link to user's feed

import { postFeedByApp } from 'react-native-zalo-kit'

const postFeedByApp = async () => {
  try {
    const feedData = {
      appName: 'DEMO RN APP',
      message: 'Hello World',
      link: 'https://zing.vn',
      linkTitle: 'LINK TITLE',
      linkSource: 'LINK SOURCE',
      linkDesc: 'LINK DESC',
      linkThumb: ['https://lh3.googleusercontent.com/dr8A58cYr-Mnz6mi5QCe6_I2yaCICVV0jL7fjrzWixn89HiA4BGW-KraR7yU4JappTs'],
      others: {}
    }

    const data = await postFeedByApp(feedData)
    console.log(data)

    /*
      returns: {
        success: true,
        data: "<raw message>",
        message: "format message",
        sendAction: 0 or 1 (0: sent, 1: cancelled)
      }
    */
  } catch (error) {
    console.log(error)
  }
}

Register new account

This API is to share a link to user's feed

import { register } from 'react-native-zalo-kit'

const register = async () => {
  try {
    const data = await register()
    console.log(data)

    /*
      returns: {
        oauthCode: "some value"
        userId: "some value"
        socialId: "some value"
      }
    */
  } catch (error) {
    console.log(error)
  }
}

Troubleshooting

1. Android: the parameter pkg_name and sign_key are required

This error happens because of your configuration on Zalo Developer Portal for Android is not correct, review your setup and make sure they're correct:

• Check your package name
• Check your Application Hash Key: you can use the function getApplicationHashKey to check the key of your app.

2. "Application is not registered for this request"

Make sure that you have request for all permissions needed from Zalo Developer portal:

Approval process is easy, so just request for everything :)

Check Supported APIs also

3. "The application is not approved"

Check that your configuration on Zalo Developer Portal is correct: Bundle/Package ID, app hash key, request for permissions, app ID is correct,...

4. "Bạn chưa cài Zalo"

Make sure in Manifest.xml you add the following:

<manifest>

  # Others...

  <queries>
    <package android:name="com.zing.zalo" />
  </queries>
</manifest>

Demo

To run the demo project, run the following commands:

# from root folder
yarn

# from root folder
yarn example android

# from root folder
yarn example ios

Thank you

If you like this project, encourage me by giving me a ⭐️. Happy hacking