Stipop Docs | Documentation for SDK and API

Quick Start

Welcome to Stipop iOS Sticker UI SDK. With just a simple integration process you can add optimized Sticker UI and over 150,000 unique stickers to your chat interface. Take the steps below to get started right away.

Stipop Stickers

Requirements

  • Swift 5.4 +
  • XCode 12.5 +
  • Apple Silicon(M1) Available
  • iOS 10.0 or higher
Stipop Stickers

Requirements

  • Swift 5.4 +
  • XCode 12.5 +
  • Apple Silicon(M1) Available
  • iOS 10.0 or higher


Step 1: Install Sticker SDK

We support Swift Package manager and Cocoapods for dependency manager.
We recommend you to use Swift Package Manager rather than others.

Swift Package Manager

By XCode

Go to File > Swift Packages > Add Package Dependency... and Copy & Paste the URL Below.
Then, select a version you wanna use.

https://github.com/stipop-development/stipop-ios-sdk

By Package.swift

If you already have a Swift Package, simply add dependency into Package.swift

Package.swift
dependencies: [
  .package(url: "https://github.com/stipop-development/stipop-ios-sdk.git", .upToNextMajor(from: "0.2.1-beta.0"))
]

Cocoapods

Add Stipop into Podfile. Then, pod install

Podspec
pod 'Stipop', '~> 0.2.1-beta.0'

Step 2: Download Stipop.plist

By creating your Stipop application you can access everything required to start integrating the Sticker SDK, like API key, analytics, and more.

    Rocket

    1. Sign up on Stipop Dashboard


    Go to the Stipop Dashboard and create a new account.

    Stipop Stickers

    Rocket

    2. Create Application


    Once signed in, create your first application by entering basic information such as app name.

    Stipop Stickers

    Rocket

    3. Download Stipop.plist


    Lastly, when you arrive at Dashboard Quick Start page, download Stipop.plist file for iOS. You'll use this file in step 3.

    Stipop plist

Step 2: Download Stipop.plist

By creating your Stipop application you can access everything required to start integrating the Sticker SDK, like API key, analytics, and more.

1. Sign up on Stipop Dashboard


Go to the Stipop Dashboard and create a new account.

2. Create Application


Once signed in, create your first application by entering basic information such as app name.

3. Download Stipop.plist


Lastly, when you arrive at Dashboard Quick Start page, download Stipop.plist file for iOS. You'll use this file in step 3.

We currently provide the SDKs in iOS, Android, and soon JavaScript will be updated.

Step 3: Setup Stipop SDK

1. Setup Stipop.plist

At XCode's root directory, Drag & Drop the Stipop.plist file you downloaded from the Dashboard into your iOS app module root directory.

Stipop Stickers

At XCode's root directory, Drag & Drop the Stipop.plist file you downloaded from the Dashboard into your iOS app module root directory.

Stipop Stickers

Stipop.plist contains your API Key. So you MUST keep it private. Once it's been leaked, make sure to regenerate one immediately.

2. Import Stipop

If it's all done, you can import our SDK in your app.

import Stipop

3. Initialize Stipop

You should initialize Stipop SDK before use.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import UIKit
import Stipop

@main
class AppDelegate: UIResponder, UIApplicationDelegate {
    ...
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.
        
        Stipop.initialize()
        
        return true
    };
    ...
}

We’re here to help. Contact us.