Before You Begin
Welcome to Stipop API Documentation for chat stickers! Here's a quick overview of what is provided through chat sticker APIs. Check out the Quick Start for basic information you need to get started and follow tutorials or shoot off building using API endpoints right away.
Chat Sticker API Highlights:
- Extensive sticker library with 150,000+ stickers
- Sticker search in 40+ languages
- Full features including weekly sticker update and seasonal stickers
Before getting started make sure to sign up on Stipop Dashboard and create application to get unique API key to make successful API requests on your app. No credit card is required and you'll get plenty of free credits to get started, so no worries! The Stipop API is internally implemented based on the RESTful principles. Our API has predictable resource-oriented URLs and is designed to use standard HTTP response codes, authentication, and verbs.
Next, decide which of the sticker feature you'd like to implement first.
You can choose from a simple sticker search integration for instant usage all the way to sticker picker and a store if you are looking for ways to monetize your app. Remember, this is just a starting guide. You can always use sticker APIs to develop features in your own way.
Tutorials for main features:
- Sticker Search: like the GIF search integrations on chat but for stickers.
- Sticker Picker and Store: like FBM sticker keyboard and store.
Below are some basic information to help you guide through the document. Once you are set continue to the next section to run a test API request.
Base URL
The following base URL is used in all API endpoints for chat sticker APIs. Add specific routes behind the base URL to have successful requests. Important: Base URL for camera and profile stickers are different. Click on the copy icon on the right end of the code section to copy the code.
https://messenger.stipop.io
Authentication
The Stipop API uses API keys to authenticate requests. You can view and manage your API keys in the Stipop Dashboard.
Your API key carries many privileges, so please keep it secure. Do not share your API key publicly in places like GitHub, blog, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Required | Type | Description |
---|---|---|
apikey | string | Stipop API Key for your app. Visit developer dashboard for new API Key. |