Beginner's Guide

5 min read

One, what is API

The Domicile Alliance API provides full-service capability support based on alliance e-commerce marketing business for all traffic master (media master) developers. After entering the alliance, the traffic master user can become an alliance developer and obtain the permission to use the Domicile Alliance API.

Two, account configuration

1. Join Duomai Alliance (Go to register and log in)

On the homepage of Domicile Alliance, register to join Domicile Alliance and become an alliance partner.

Icon:

2. Create media & get AppKey and secret key (AppSecret)

After logging in to Domicel Alliance, enter "My Alliance". Click Media Management in Promotion Management, click Add Media to create a media. Note: In order to promote more convenient for ordinary users, after successful registration, the system will create a default WeChat media based on the bound mobile phone. If you happen to use the WeChat media promotion associated with this phone number, you do not need to create it again. If it is not or requires more media promotion, please ignore this default media or create a new one.

Icon:

After the creation is successful, your dedicated customer service will review your media. You can also directly contact your dedicated customer service to speed up your media review. After the media is successfully created, you can obtain AppKey (site_id) and AppSecret (hash), thereby enabling technical access Use API View API Access Document

Three, find and apply for plans

After creating a media, you can find a plan suitable for your promotion through the main background or interface of the traffic. After obtaining the promotion qualification, you can transfer to chain promotion to earn commission.

1. Plan query

1.1. Traffic main background query (Go to check the plan)

Enter the main background of traffic, click [Promotion Plan] under [I want to promote], enter the promotion plan, and you can check all the plans currently available for promotion

Icon:

1.2, api interface query

Query Plan API Interface

2. Apply for the plan (Go to apply for the plan)

Part of the promotion plan should be requested by the merchant or brand, and the promotion media needs to be reviewed or filed before the promotion qualification can be provided. Such plans need to be promoted after application.

2.1. Plan a single application

You can directly find the plan that needs to be promoted but need to apply in the list of [Promotion Plan] under [I want to promote] in the main background of the traffic, click the application operation, select the media that promotes the plan and submit the application.

Icon:

2.2, plan batch application

If you need to apply in large quantities to obtain the promotion qualification of the plan, you can also select all the plans in the [Promotion Plan] list at the top left of the form, and then click "Bulk Application". In the same way, you can apply for all the plans that need to be applied for in the list after selecting a promotion media.

Icon:

Fourth, promotion plan

When the plan application is passed or there is no need to review, you can directly find the plan that needs to be promoted in the [Promotion Plan] list under [I want to promote] in the main traffic background, and click "Get Link". Then select media with promotion qualifications to get the converted link.

Icon:

You can also enter the plan details page to get the plan link

Icon:

When you need to export plan links in large quantities in the main traffic background, you can go to the [My Promotion Plan] under [Promotion Management] and find the plan you have already obtained (the plan that you have transferred or applied for is regarded as "My Plan", you can get it through the above batch application). Click "Export and transfer link" to export all the converted link documents of your plan.

Icon:

Get plan link API interface

Five, order push and pull

After the user places an order at a third-party merchant, the order will be pushed from the third-party merchant to the Domai Alliance, and the Domai Alliance will push the order to the main flow platform, and the main flow platform can also obtain the latest order information according to the order pull interface Pull.

5.1, order push configuration

In the main flow background of Domicile Alliance, configure the address to receive the order push. After the test passes, Domicile Alliance will push the relevant order data to the receiving address of the main flow platform.

5.2, order pull

The main traffic platform can pull order data from the Domicel Alliance according to its own needs