Loading…

apifm Frontend PaaS & AI Dev Platform

SDK

Homepage Open Source Help center Cases Contact Backend management

Communication group

Installation tutorial

WeChat Mini Program installation

Vue develops web or h5 applications

Byte/Toutiao/Douyin Mini Program

Flutter installation

uni-app installation

built-in methods

Set up a dedicated domain name

Modify merchant ID

Universal calling api address

Tool interface

Alibaba Cloud Content Detection Service

Convert rich text content in html format to plain text

Call the background mock data interface

Query IP location

Long link/short link conversion

Get unique serial number

Query mobile phone number location information

Get mobile phone number segment data

Upload files (pictures/videos)

Province, city and county data

Automatically identify and extract administrative district data

Keyword search administrative area

Read details by ID

Get all provinces

Get next-level geographic information

Get all city data

Get all district and county data

Get all street data

Read extended address list

Temporary data storage

Polls & Questionnaires

Read the list of voting items (pull questionnaire)

Get question details (list all options)

Submit voting [single question]

Submit vote [by category]

My voting record [single question]

My voting record [question bank classification]

My voting details

View the voting history of people I invited

Json data management

Get Json data list

Add/modify Json records

Delete Json record

Pinned Json record

Set Json record highlighting

time date

Calculate the number of milliseconds difference between two times

Read server time

Get the date in the next few days

Queue to get a number

Queuing progress query

Get queue classification

Distributed synchronization lock

deposit

My deposit record

Map related

Driving route planning

reverse geocoding

Search for places within a given area based on keywords

Calculate the distance between two locations (non-straight line)

Calculate the straight-line distance between two locations

Find a geographic location by latitude and longitude

System settings

Read system parameters (single)

Read system parameters (batch)

Integral module

growth value

Points exchanged for growth value

Growth value details

Points are about to expire statistics

Summary of points for currently logged in users

Read the latest 50 points updates

User points ranking by date

Total ranking of user points

Replenish a specified number of points every day

Read the points gift rules

Get points by signing in every day

Read the rules for bonus points for consecutive sign-ins

Determine whether you have signed in today

Sign-in interface

Read historical check-in records

Redeem points coupons for points

Redeem points for available balance

Read points details

Earn points by doing tasks

Mark a task as complete

CMS

Article classification

Read single page data

Article management

Ranking of article publisher views

Modify extended count field

Post an article

Delete your own articles

Get article list

Read article details

Get the previous/next article

Like/dislike the article

Collection

Check whether it can be collected

Collect articles

Get a list of favorited articles

Delete collection based on collection record ID

Delete collection based on article ID

Message interface

Pull message/comment list

Delete your own message

Event check-in

Get the list of signed-in users for an event

Online event user sign-in

Offline event manager sign-in

Check whether an event is signed in

Mall module

Brand management

Brand Collection

Check if it has been collected

Delete brand collection

Add brand collection

Brand collection list

Get commodity transaction updates

Product management

Product out of stock registration

Seize the flash sale quota

Product classification

Product details

Product details

Optional accessories for the product

Read purchase limit settings

Pull evaluation data

Get product price

Get product tiered pricing information

Get member prices/discounts for products

Get the price and inventory of a certain SKU

Get daily pricing and inventory for items

Product likes/dislikes

Browse footprints/history/purchased items

Get a list of purchased items

Delete product purchase history

Product browsing history/footprints

Product collection

Check whether a product has been collected

Add to favorites

Get a list of favorite products

Delete favorite record

daily sales summary

User publishes products

List of products I published

Delete your own products

Period pricing

Get product period pricing calendar data

Get all dates for product period pricing

Get all time period information of a certain day for a product

Product purchase ranking

video series

Get the list of episodes for a specified product

shopping cart

Mark shopping cart record selected status

Clear shopping cart

Read shopping cart data

Modify the quantity of items in the shopping cart

Delete shopping cart records

marketing tools

Mall activities

Mall activity details

Lottery

Read my lottery information

Participate in the lottery

Get details of lottery items

Lottery participation records

Bargain

Read the bargain setting of the product

Initiate bargaining

Delete bargaining record

Read the details of the bargaining initiated by me

Read the bargaining process

Help a friend to chop a knife

Get the help record

Coupon

Write off coupons

Get all available coupons

View coupon details

Combine coupons

Give coupons to others

Dynamic password redemption coupon

Share coupons for others to grab

Get coupon sharing key

Cancel Coupon Sharing Key

Get coupons by sharing your key

Distribution

Third level distribution

Directly upgrade to become a distributor

Distributor business statistics

Rebind distributors (grab customers)

Get annual sales statistics

Get daily (monthly) commission and sales summary records

Read background distributor settings

Apply to become a distributor

Check application review progress

Purchase distributor qualifications

my team members

Get commission records

My commission statistics

Statistics of commissions to be settled

Distributor cumulative sales ranking

Distributor team cumulative sales ranking

Distributor’s sales ranking on a certain day

Get distribution-specific products

Get team monthly reports

Urban partner information

Urban partner monthly report

Partner/team leader/team member three-level distribution

Rejection of withdrawals from users under the partner’s name

The withdrawal of the user under the partner's name is set as successful

Partners view the withdrawal list of users under their name

Get member list

Team status under your name

Buy to become a partner

Buy to become a team leader

Bind team leader

Read the background partner distribution settings

Group sharing

Read the group setting of the product

Get the default group setting for a specified product

Get tiered group buying prices

Initiate a fight order

Get group sharing information

Get a list of all currently ongoing group purchases

Get a list of members of a group

Get a list of all the groups I have participated in

Merchant/Store

Store area information

All cities available in the store area

Store area list

Store area details

store information

Get a list of store/merchant reviews

Store/Merchant Classification

Get a list of pickup points

Get my store information

Store application

Get the city list of all available stores

Read merchant/store list

Read store details

Order management

My order statistics

Read background order settings

Order list interface

Order details interface

Create order/place order

Pay order with balance

Order write-off

Confirm receipt

Evaluation

My review list [for products]

Order evaluation (good, medium, negative)

Close or cancel order

recurring subscription

Stop recurring subscription

Start a recurring subscription and restart a stopped subscription

Delivery related

fast runner

Read the fast runner order process

Read the fast runner delivery person positioning

Flash delivery

Get instant test order details

Get instant rider information

Meituan delivery

View order Meituan delivery positioning

The merchant delivers it himself

Delivery worker performance statistics

Get the background setting delivery fee list

The delivery administrator obtains the list of all delivery persons

The delivery person reads his own delivery information

Modify order status

Available order list

Delivery order list

Delivery order details

Delivery man grabs order

Administrator manually dispatches orders

Set estimated completion time

Mark for delivery

Mark as shipped

Modify remarks on delivery completion

After-sales

Fill in the return package information

Apply for after-sales service

Get after-sales details of your order

Cancel after-sale service

Get order refund records

Pay for knowledge

My purchase history

Purchase virtual items

Virtual item details

virtual item list

Scan code to order food

Scan code to order and checkout interface

Table number list

Table number details

Scan the QR code to place an order

Get the table Token and uid based on the table code ID and key

Product display window

View user window information

Modify window information

List of window products

Add products to the showcase

Remove items from display window

Determine whether the product is in the window

Community group buying

Notify users to pick up goods at the self-pickup point

Pay the leader recruitment fee

Apply for club leader information

Apply to become a club leader

Get community group buying setting information

Solitaire

Read the participation list of Solitaire

Remove product from Solitaire

Add products to Solitaire and users can purchase them

Delete the Solitaire record. You can only delete it after canceling the Solitaire record.

Solitaire is formed into a group, and users are cut off from continuing to participate.

Canceling Solitaire, all paid orders will be refunded

Solitaire details

Add/modify Solitaire

List of Solitaire initiated by me

Read Solitaire settings

Mini program development

Alipay Mini Program

Bind mobile phone number

WeChat Mini Program

In the merchant transfer user confirmation mode, the WeChat client opens the page through the mini program to request the user to confirm the payment.

The currently logged in user is bound to WeChat Mini Programopenid/unionId

Subscription message and frequency management

Forward to WeChat group to give users points

Get WeChat Mini Program code

Get the mobile phone number bound to WeChat

QQ applet

Get the applet code

Byte applet

Get the applet code

Site operation

Obtain an exclusive domain name through WeChat Mini Programappid

Contact support list

Get site information

System Announcement

Banner carousel chart

Friendly links/partners

Read the membership type of the current site

Login&Registration&Authorization

Read the list of all currently logged in devices

Check whether the token is valid

Check whether the inviter is valid

Alipay Mini Program authorizes to obtain user token

WeChat Mini Program authorizes to obtain user token

QQ applet authorizes to obtain user token

Byte applet authorizes to obtain user token

Login interface

WeChat Mini ProgramLogin

WeChat Mini Program One-click login with mobile phone number

Byte applet login

QQ applet login

Login with username and password

Login with mobile phone number and password

SMS verification code login

Registration interface

Register user with email

Easy registration for WeChat Mini Program users

Detailed registration for WeChat Mini Program users

QQ applet user detailed registration

Toutiao Mini Program User Registration

Register user by username

Register a user through mobile phone number verification code

One-click authorization (login & registration)

WeChat official account web page authorized login

Users&Members&Social

Blind box dating

Get blind box settings

Get my match and delivery balance

Unlock blind box

Get the rules for giving away the number of recharge unlocks

Delivery record

Delete my posted data

Modify delivery status

Purchase unlock times

Pay for the blind box to be paid

Place blind box

Get 5 blind boxes by matching

Get information about any user

Get random nickname/screen name

Read user visit status

Bind salesperson

User details

Get user details

Obtain the user ID and accesstoken of Alipay Mini Program

Get WeChat openid and unionid

Get user dynamic membership code

Get the user information I invited to register

Edit profile

User modified information

Retrieve password

SMS verification code to reset password

Email verification code reset password

SMS verification code bound to mobile phone number

Byte applet binds mobile phone number

WeChat Mini Program binds mobile phone number

Set login username

Change login password

Bind email address [can be used to log in]

friends

Read friends list

View friend profile

IM chat & message

Pull chat history with friends

Send a message to a friend

Clear chat history

Moments & Updates

Post to Moments

Pull Moments timeline

View Moments record details

Delete Moments records

Delete a comment in Moments

Like in Moments

Moments comments

Moments updates

drift bottle

A drift bottle is still a bottle

drift bottle pick up bottle

Shipping address management

Add shipping address

Modify shipping address

Read the shipping address list

Get shipping address details

Get default shipping address

Delete shipping address

Membership level

Get all membership levels set in the background

Get membership level details

Get membership fee items

Purchase membership level

Get my purchase history

Bind bank card

Read bound bank card information

Read optional bank list

Bind billing information

Read user-bound invoicing information

Real-name authentication [manual review]

Real-name authentication [automatic review]

Log out (delete) user

User messages & site messages

Delete messages & site messages

User message & site message list

User tag authentication

User tag authentication

Query user tag authentication status

Third party integration

JD VOP

Must read before calling

Get product list

Get VOP product details

Get product carousel images

Check if it is available for purchase

shopping cart

Get shopping cart data

Modify the quantity of a product in the shopping cart

Select/deselect a record

Remove a record

Clear shopping cart

Pay online

stripe

Delete bound bank card

List of bound bank cards

Wing Pay

Wing Pay evokes H5 cashier

Yi payment order interface

Read the recharge gift rules

General method for initiating payment

Payment status inquiry

WeChat Pay

WeChat Mini ProgramPayment

WeChat h5 web payment

WeChat official account payment

Users actively scan WeChat QR code to pay

The merchant scans the user's WeChat payment code to complete the payment

APP payment (Android, ios)

Byte applet payment

CCPAY & VVPAY mini program payment

Alipay

Get visa-free payment code

Alipay Mini ProgramPayment

Alipay computer web payment

Alipay h5 terminal payment

APP payment (Android, ios)

Users actively scan the QR code to complete payment

The merchant scans the user's Alipay payment code to complete the payment

Exchange rate query interface

Verification code

Graphic verification code

SMS verification code

Email verification code

Financial management & capital related

Transaction password & payment password

Reset transaction password

Change transaction password

Set transaction password for the first time

Obtain user's available balance, points and other assets

Read the fund details list

User income and expenditure statistics

Get recharge/payment records

Invoice business

View all invoices I applied for

View invoice details

Apply for invoice

Withdraw cash

Read background withdrawal settings

Withdrawal records

Withdrawal record details

Apply for withdrawal

Get full discount rules

Offline purchase order

Deposit function

Users actively pay the deposit

Get my deposit record list

Deposit record details

Apply for deposit refund

membership card

Gift to friends

Receive membership card via secret key

Get sharing key

Get membership card with password

Get a list of membership cards available for purchase

View membership card details

Buy membership card

Get my membership card

My membership card consumption details

Streaming media & audio and video

Obtain the Alibaba Cloud on-demand service upload certificate

Get video information based on video number

WeChat Mini Program live broadcast

Get the list of live broadcast rooms

Get historical replays of the live broadcast room

Real-time audio and video

TRTC obtains userSig and other information

Events & Appointments

Collection

Appointment registration collection list

Delete appointment registration collection

Add appointment registration to favorites

Check if it has been collected

Register Team

List of all teams that have booked/registered for the project

The team leader of the reservation/registration project deletes a member

Team details for reservation/registration project

Make an appointment/register for a project to obtain a list of team members

Like the reservation project

CP matching activities

cp matching activity details

voting campaign

Registration record details

Voting activity to collect votes

Rules for redeeming voting points for number of votes

Voting Event-My Votes Balance

Voting Campaign - Take a Vote

Sign up to vote

Voting event to obtain participation list

List of voting activities

Errands & Tasks

Publisher confirms acceptance

After accepting the order, click Finish

Pay mission bounty

User posts events/appointments

User deletes reservation items posted by himself

Reservation/Registration Item List

Reservation project details

Appointment/Registration

Pay registration fee

mine

Users complete reservations themselves

Modify reservation/registration information

Delete registration record

My appointment/registration record

Waiters & Technicians

Get list of attendants/technicians

Get attendant/technician details

Services (goods) that technicians can provide

Technician setup services available

Get technician schedule information for a service

Query the available appointment time slots on a certain day set by the technician

The technician sets the time slot that can be reserved

Technician binds merchant/unbinds

Technician changes work status

Technician evaluation list

Technician's work uniform photo list

Technician deletes photos of work clothes

Technician adds photos of work clothes

Modify technician personal information [Apply to become a technician]

Technician Collection

Collection Technician

Check whether a technician has been collected

Get a list of favorite technicians

Delete favorite technician

Order operations

Technician order statistics

Technician takes order

Set order as serviced/transaction completed

Set the order to be in service/start service

Team/organization/collaborative office/shared network disk

Netdisk

Delete network disk files

Modify network disk file information

Get the network disk file list

Network disk file download

Upload files to network disk

Announcement

Delete organization announcement

Organization announcement addition/modification

Get organization announcement details

Get a list of organization announcements

Get a list of organization charges

Create an organization

Upgrade the size of the organization

Modify organization information

Invite members to join the organization

Make (cancel) someone an administrator

Members leave the organization

Set your own nickname within the organization

Disband the organization (delete the organization)

Get list of organizations

View organization details

Get member list

Share tables/share fields/share documents

Initialize table data

Get all cells of shared table

Set cell content

Polling to read cell modification dynamics

WeChat public account development

The currently logged in user is bound to openid

Obtain JS-SDK usage permission signature

Promotion and operation

hair tie material

Hair tie material details

Hair tie material list

Get hair tie material classification

CPS

Taobao

Taobao Alliance obtains short links

Taobao Alliance obtains Taobao password

Taobao Alliance product details

Pinduoduo

Pinduoduo Alliance order details

Pinduoduo alliance order list

Pinduoduo Alliance obtains short links

Pinduoduo Alliance product details

Pinduoduo promotion space and user registration

JD Alliance

Jingdong alliance product chain transfer

JD Alliance Product Search

Jingdong product settings coupon information

Jingdong product query last set coupon information

JD Alliance product details

JD Alliance Category

IoTIoT

Get the list of IoT devices corresponding to the specified order

Get the list of control instructions supported by the device corresponding to the specified order

Execute device remote commands

AI

Customized

MTJ

Dividend record

Read MTJ transfer record details

Transfer MTJ to other users

Read background MTJ settings

Read your own MTJ capital flow

Read your own MTJ assets

Get the total MJT issuance status of the current site

Collect cards

Card collection record details

Card collection record

View card details by card number

Unbind favorite card

Bind collection card

course sales

Use your balance to pay for course purchase orders

Get my registration record

Registration record

Purchase course order details

Delete course purchase order

Close course purchase order

training module

View student sign-in records

List of staff dormitories

daily diet list

Teacher function

Teacher views student list

Teachers add/edit staff dormitories

Teachers view details of staff dormitories

Teacher deletes staff dormitory

Teacher adds/edits daily meals

Teacher checks daily meal details

The teacher deletes the meal for a certain day

Teacher’s daily management content added

Teacher daily management list

Teacher deletes daily management records

Parent function

Students view parent list

Parents bind relationships with students through invitation codes and secret keys

Students obtain the secret key to invite parents, which is valid for 5 minutes

Parents check students’ sign-in records

Parents view student list

Read my parental identity information

Coach function

Training plan completed and set results

Coach sets training plan for students

The coach deletes the training plan for the students

Add entrance examination scores to students

The coach fills in the staged assessment results for the students

The coach fills in the confrontation record for the students

The coach fills in the game record for the students

Attendance list

Attendance sign in or out

View student competition records

View student confrontation records

View students’ staged assessment results

Get all training programs

Training item classification

View students’ entrance examination results

Publicly viewable student training plan

View student training plan

Student details

Publicly viewable list of students

View student list

Coach evaluation list

Event module

Tournament victory points ranking version

Event victory points details

The referee sets the table number

The referee backfills the game results

Get schedule matchup chart data

Contestants draw lots to get their lottery numbers

Event schedule registration

Event schedule registration list

List of races I signed up for

Tournament schedule details

Event schedule list

Event information details

Event group list

game

Neon Block Rush

Neon Block Rush Weekly Rankings

Neon Block Rush game over

Neon Block Rush game starts

Get the current energy value of Neon Block Rush game

Digital Bomb King

Digital Bomb King-Game Record

Digital Bomb King-Guess the bomb location

Digital Bomb King-Start a new round of gaming

Picture trading

Picture purchase record details

Picture purchase history

Record of using balance to pay for pictures purchased

List of all image libraries in Image Exchange

TG

TG BOT front-end js authorized login

TG BOT payment star

Table number details

Table number details

SDK apifm Development reference

```javascript WXAPI.cyTableInfo(id) ``` + id table number record id