Potato Developer Platform

Using Potato API
Connect to your service

Bring automation tools, content services and business experience into Potato sessions through Bot API, authorized login and mini program capabilities.

Development capabilities

From robots to lightweight applications

Choose the appropriate access method according to the product scenario. Before formal development, please refer to the current official interface documents, permission descriptions and review requirements.

01

Bot API

Send and receive updates, send messages and connect to back-end services through a simple HTTPS interface, suitable for notifications, customer service, tools and automation scenarios.

  • Message, command and callback interaction
  • Group and channel auxiliary functions
  • Inline results and custom keyboard
Learn about Bot API ›
02

Robot

Bots are third-party applications that run within Potato. Users can invoke it via messages, commands, and inline requests in private chats, groups, or input boxes.

  • Content subscription and real-time notification
  • External service integration
  • Customized tools and group management
Learn about bots ›
03

Authorize login to SDK

Obtain necessary basic information through user authorization for establishing account systems and business processes. Request only the permissions necessary to complete the service.

  • Clear user authorization process
  • Obtain basic identity information
  • Applicable to website and app login
View login access guide ›
04

Potato applet

Build lightweight applications or mini-games that can be spread in chat and community scenarios to provide shorter access paths to content, services, and transactions.

  • In-session discovery and sharing
  • Lightweight interactive experience
  • Access payment according to platform capabilities
Mini program development guide ›

Quick start

Four steps to complete basic access

The following is the general process. The specific fields, interface addresses and review steps are subject to official documents.

1

Clear scenario

Determine the target users and core processes of the robot, login or mini program.

2

Create Application

Create an application or robot according to the platform process, and keep the authorization credentials properly.

3

Connection service

Handle updates, business logic and responses through the HTTPS interface.

4

Test online

Cover errors, permissions and security scenarios, and complete the review before officially releasing it.

Bot Interactive

Ability suitable for conversation scenarios

Commands

Use commands starting with a slash to provide stable, discoverable entry points to functionality.

Customized Keyboard

Reduce input costs through preset options and quickly collect structured operations.

Inline Mode

Let users search and send content by bot username in any session.

Real-time updates

Use callbacks and inline keyboard to update existing messages to keep the session clean.

Group Privacy

Follow the principle of minimum visibility and only process the information required by the robot to complete the task.

Deep link

Bring users to designated robots or business processes through shareable portals.

Develop safety checklist

  • Tokens are only saved on the server side and writing of front-end code is prohibited
  • Use HTTPS and verify the request source and parameters
  • Only apply for and save the data required to complete the business
  • Add authentication, current limiting and auditing for sensitive operations
  • Immediately rotate and troubleshoot access records after the token is leaked
  • Prepare privacy instructions and user support channels before going online

Ready to start building?

Read the introductory information on robots first; if you need business or platform access support, you can contact us directly.