Stipop Docs | Documentation for SDK and API

Before You Begin

Welcome to Stipop Sticker SDK for Android. With a simple integration process, you can add optimized Sticker UI and over 150,000 stickers to your chat app. Follow the steps below to get started.

Stipop Stickers

Requirements

  • Android 4.1 (API level 16) or higher
  • Java 8 or higher
  • Support androidx only
  • Gradle 3.5.4 or higher
Stipop Stickers

Requirements

  • Android 4.1 (API level 16) or higher
  • Java 8 or higher
  • Support androidx only
  • Gradle 3.5.4 or higher


Try our demo to see Stipop in action before integrating it into your app.
If your project is built on Java language, you can also test Java Demo .


Step 1: Download Stipop.json

    Rocket

    1. Sign up on Stipop Dashboard


    Go to the Stipop Dashboard and create an account.

    Stipop Stickers

    Rocket

    2. Create Application


    Once signed in, create your first application by providing a few details about your app.

    Stipop Stickers

    Rocket

    3. Download Stipop.json


    You will see the Stipop.json file for Android on the Before You Begin page of your Dashboard account. You will need this file in step 3.

    Stipop Json

Step 1: Download Stipop.json

1. Sign up on Stipop Dashboard


Go to the Stipop Dashboard and create an account.

2. Create Application


Once signed in, create your first application by providing a few details about your app.

3. Download Stipop.json


You will see the Stipop.json file for Android on the Before You Begin page of your Dashboard account. You will need this file in step 3.



Step 2: Include the SDK into your project

1. Add the JitPack repository to your build file

Add it to your root build.gradle at the end of repositories:

build.gradle

allprojects {
  repositories {
    maven { url 'https://jitpack.io' }
  }
}

2. Add the dependency

Add it to your app level build.gradle at the end of dependency:
Check out the Stipop Android SDK Release Notes . We recommend using the latest release.

build.gradle

dependencies {
  implementation 'com.github.stipop-development:stipop-android-sdk:0.6.0'

  // Optional //
  // Maybe you need to extend 'MultiDexApplication' at 'Application' class.
  implementation 'androidx.multidex:multidex:{version}'
  // You additionally need to this library, if your project does not configure 'Kotlin'.
  implementation 'org.jetbrains.kotlin:kotlin-stdlib:{version}'
}

Step 3: Setup Stipop SDK

1. Setup Stipop.json

Step 1: Create assets folder in app>src>main if you don't have one.

Step 2: Move the Stipop.json file you downloaded from the Dashboard into the assets folder.

Stipop Stickers

Step 1: Create assets folder in app>src>main if you don't have one.

Step 2: Move the Stipop.json file you downloaded from the Dashboard into the assets folder.

Stipop Stickers

Stipop.json contains your API Key. Keep it private. If it gets leaked, make sure to regenerate a new one immediately.

2. Make or update your application class

Call 'Stipop.configure(context)' at application class to initialize the SDK from 'Stipop.json' file. If you want to know about 'Stipop.configure', refer to Optional Settings - Configure .

Application
1
2
3
4
5
6
7
8
9
10

import androidx.multidex.MultiDexApplication
import io.stipop.Stipop

class MyApplication : MultiDexApplication() {
    override fun onCreate() {
        super.onCreate()
        Stipop.configure(this)
    }
}

3. Update AndroidManifest.xml

Update your 'AndroidManifest.xml' to specify application class.
Make sure your application includes 'INTERNET' permission to perform network operations.

AndroidManifest.xml
1
2
3
4
5
6
7
8
9
10
11
<?xml version="1.0" encoding="utf-8"?>
<manifest>
    <uses-permission android:name="android.permission.INTERNET"/>
    ..
    <application
        android:name=".MyApplication"
        ..>
          <activity />
          ..
    </application>
</manifest>

We’re here to help. Contact us.