# Broearn # User Guide ## **Broearn Developer Platform User Manual** Welcome to the Broearn Developer Platform! We are delighted to provide support on your development journey. Please follow the steps below to start using the Broearn platform. ### Register and login #### **Business Scenario Introduction** By joining the Broearn ecosystem, we will provide your h5 application with multi-scenario traffic support. Now you can use the Broearn App to generate a wallet private key account and use the Broearn App to scan the QR code to log in or register for the Broearn developer platform account via email. (Note: To avoid loss of account, remember to save the wallet private key generated by the app) #### **Operation Guide** To register for the Broearn developer platform, you can choose between login with Broearn APP by scanning QR code or registering by email. Please follow the steps below:
#### QR Code Login: * Log in using the Broearn APP by scanning the QR code (no registration required). * Log in by scanning the QR code with the Broearn APP, or directly log in with the Broearn Wallet plugin. #### Account/Password Registration: * Enter your commonly used email, password, and contact information. * Check whether there is a verification email in your inbox. * Click the link in the email to verify and successfully complete the registration process. Register using your email address as your Broearn Developer Platform account name. Your account and password will be encrypted and stored on the server. It is recommended that you keep your Google OTP safe to prevent your account from being misused by others.During registration, you can choose to fill in your contact information so that we can contact you and provide you with the services and consultations of the Broearn Developer Platform. You can log in to the Broearn Developer Platform by correctly filling in your account, password, and Google verification code. #### Frequently Asked Questions **Q:** What is the Google verification code that needs to be entered when logging in to the Broearn Developer Platform with an email? **A:** The Google verification code entered when logging in to Broearn with an email is the dynamic verification code generated by Google OTP. ### ### Create Dapp #### **Introduction of Business Scenario:** Now start creating your first Dapp, it only takes a few minutes. Publish your H5 product to Broearn Dapp with one click, and enjoy global traffic. #### **Operation Guide:** After logging in to the homepage of Broearn Developer Platform, select the Dapp tab under Dapp Management menu in the left navigation area and click Create Dapp.
* Fill in the Dapp Logo, Dapp Name, Dapp Introduction, Dapp Link, Supported Network, Dapp Category, Countries to Deploy, Category, etc. according to the diagram, and submit it for review.
Once submitted, your Dapp will enter the review stage. The Dapp review will be completed within 1-2 business days.
* After the review is passed, the platform will generate three types of promotional links based on your Dapp information, and developers can choose them freely. * If the review fails, please adjust according to the reasons for failure and resubmit for review. #### Frequently Asked Questions **Q:** What is the Dapp link that needs to be filled in during the Dapp creation process? **A:** The Dapp link you fill in is actually your h5 application link. Q: What is the support network chosen when creating a Dapp? A: It's the public chain network needed for Web3.0. ### ### Create a Promotion Campaign #### **Business Scenario Introduction:** Creating a promotional campaign can help you promote the Dapp you have created. After creating a promotional plan, you can generate a delivery link, which can help you attract more users to install and use your application. #### **Operation Guide:** After completing the creation of Dapp, click on the promotion plan tab menu to create a plan. After filling in your third-party channel account information and setting up a promotion strategy on the Broearn developer platform, you can generate three exclusive delivery links for you. (Multiple promotion links can be created for the same Dapp.)
To create a promotion plan, you need to use the above information to open an account on the Facebook advertising platform (based on what you see on your own FB platform page). To fill in the account information, click to contact customer service for addition.
* Media Placement: Choose media placement, supporting Facebook, Google Ads, Kwai, TikTok, and other media. We will take Facebook as an example to introduce the following process. * Fill in the information as shown in the picture, such as Dapp, promotional product, media placement, countries to place ads in, promotion settings, data reports, etc., and submit it for review.
#### **Frequently Asked Questions** **Q:** How to fill in the account information? **A:** You can contact Broearn's online customer service to submit the account information of the channel you have chosen. **Q:** How to understand the explanation of the information required in the process of creating a promotion plan? **A:** You can move your mouse to the title of the information you need to fill in to view the relevant explanatory notes. **Q:** What is event binding in the process of creating a promotion plan? **A:** It refers to the target ad placement event, that is, in the "app event" area of the FB Pixel settings, select the application events to be tracked and optimized. ### Dashboard #### **Business scenario introduction:** The dashboard data unlocks the potential of data to drive product growth and serves as your Dapp data visualization expert. It mainly provides the following two points: * **Instant Insights:** It provides real-time core data analysis for your Dapp and promotional links, making your decisions more precise. * **Data Visualization:** Through intuitive charts and reports, complex data is transformed into easy-to-understand visual information, simplifying product analysis.
Here is an overview of the key features available: 1. Basic Operational Data: * Deeply understand key indicators, such as total number of users, number of active users, number of sessions, etc. * Track and monitor important performance indicators related to your product. 2. Real-time Users: * View the number of real-time users, allowing you to understand the number of active users currently interacting with your product. * Monitor ongoing user activities and participation patterns. 3. User Trend Chart: * Visualize user trends over time through graphical representation. * Identify patterns, peaks, and troughs in user activity to understand user behavior and make wise decisions. 4. User Retention Chart: * Analyze user retention rate and visualize the number of users who return to your product within a specified time interval. * Evaluate the effectiveness of user retention strategies and identify areas that need improvement. 5. User Distribution Chart: * Explore the geographical distribution of your user group on an interactive map. * Understand where your users are located and determine potential target areas for marketing and expansion. The data dashboard allows you to deeply understand product performance and user behavior. Make data-driven decisions and optimize your product using these tools. ### Campaign Report #### Business Scenario Introduction： **Comprehensive Application Data Analysis to Help You Operate Precisely and Achieve Rapid Growth** Utilizing the Campaign Report feature of Broearn Developer, you can fully understand advertising data effects, optimize advertising strategies, and maximize user conversion rates and advertising revenue. It specifically delivers the following three key offerings: * In-depth Analysis: Dig deep into user behavior, optimize product strategies, and enhance user experience and business growth in a data-driven way. * Decision Support: A robust data support system that assists you in quickly identifying market trends and making wise business decisions. * Customized Service: Based on your specific needs, we provide personalized data analysis solutions to ensure that your product is always one step ahead. #### **Operation Guide:** Select the navigation bar on the right, click on "Campaign", choose the Dapp or team you want to view, and you can display the view data as per the diagram below:
This report helps analyze your ad campaigns and make data-driven decisions. Key metrics included in the report: 1. Ad Spend: * Shows the total expenditure of ad campaigns within a specific period. * Helps you track your ad budget and costs. 2. Impressions: * Shows the number of times your ads are displayed or viewed by users. * Provides insight into the reach and visibility of your ad campaigns. 3. Ad Clicks: * Indicates the number of clicks your ads receive from users. * Measures the user engagement and interest in your ads. 4. CTR (Click-Through Rate): * Calculates the percentage of users who click your ads after viewing them. * Helps evaluate the effectiveness and relevance of ad content. 5. CPC ($) (Cost Per Click): * Represents the average cost generated per ad click. * Assists in evaluating the efficiency of ad spend and campaign performance. 6. CPM ($) (Cost Per Thousand): * Reflects the cost of 1,000 ad displays. * Enables you to compare costs across different ad campaigns and channels. 7. Installations: * Tracks the number of app installations resulting from ad campaigns. * Allows you to measure the success of ads in driving user installs. The delivery report provides you with valuable data for analyzing the performance and effectiveness of your ad campaigns on channels like Facebook. Use these statistics to optimize your ad strategy and make informed decisions to achieve your campaign goals.
### User Analysis #### Introduction to the Business Scenario: Our user analytics feature provides you with comprehensive user behavior and activity analysis, helping you capture every key interaction point. Here are the in-depth insights you will gain: * **Real-time interaction tracking:** Monitor every interaction users have with your platform, big or small. * **Detailed user profiles:** Construct user personas and understand their preferences, habits, and needs. * **Dynamic behavior analysis:** Real-time updated user behavior patterns, revealing potential market trends. * **Customized user journeys:** Build user journey maps by tracking events linked to ad campaigns, understanding every step from user awareness to purchase. #### **Operation Guide:** Select the side navigation bar, click on User Analysis, choose the Dapp or team you want to look at, and the following view data will be presented:
**You will be able to:** * **Improve user experience:** By understanding user needs, provide more personalized services. * **Optimize ad delivery:** Based on data analysis of user journeys, improve the accuracy and efficiency of ad delivery. * **Enhance user stickiness:** Design more attractive user interaction strategies by tracking user dynamics. # Broearn Developer {% content-ref url="/pages/XoVjLbAlNm8Fobcr8rxY" %} [Get Started](/broearn-developer/get-started) {% endcontent-ref %} {% content-ref url="/pages/9FgQfGkTobr2y4msQaay" %} [What are Dapp Developers?](/broearn-developer/what-are-dapp-developers) {% endcontent-ref %} {% content-ref url="/pages/OzGcZ2fNVWEKefWWk4Cn" %} [Introduction](/broearn-developer/introduction) {% endcontent-ref %} # Get Started Welcome to Broearn Developer! We're excited to support you on your development journey. Please follow the steps below to get started with Broearn platform: ## **Platform Introduction** #### **Product features** **Quick shelf:** Support Android quick shelf, shorten shelf time, save development costs, and make your application faster to market. **No need for review:** Skip the lengthy review process of the app store, not be restricted by third-party content, and solve the problem of apps being unable to be listed or difficult to list. **Global coverage:** multilingual adaptation, covering 200 countries and regions around the world, to meet your different traffic needs. **High-quality traffic pool: The** landing page advertising user pool is 6 times that of the application advertising user pool. With landing page media buying, the traffic pool is larger and the customer acquisition cost is reduced. **Traceable:** Support customized event reporting, all-round tracking distribution effect. ## Broearn Developer User Guide Welcome to Broearn Developer! We're excited to support you on your development journey. Please follow the steps below to get started with Broearn platform: ### **Register and log in** There are two registration methods available: QR code registration and account/password registration. Please follow the steps below:
#### **QR Code Registration:** * Use the Broearn mobile app or Broearn desktop extension program. * Scan the QR code displayed above using the Broearn app or Broearn desktop extension.
#### **Account/Password Registration:** * Enter your commonly used email, password, and contact information. * Check your email inbox for a verification email. * Click on the link in the email to verify and complete the registration process successfully. Register with your email address as your Dapp Developers account name. Your account and password will be encrypted and stored on the server. \ It is recommended that you keep your password information safe to prevent your account from being stolen by others. When registering, you can choose to fill in your contact information so that we can contact you and provide you with services and consultation on Dapp Developers platform. \ Fill in your account, password, and Google verification code correctly to log in to the Dapp Developers system. ### Create Dapp #### **Submit Dapp**
* Log in to the platform, enter "My Dapp", click on the upper right corner \[Create Dapp], fill in the relevant information to create a new Dapp.
* Fill in the Dapp name, Dapp icon, Dapp introduction, URL, access network, Dapp classification, applicable area and other information as required, and submit it for review to enter the review status. #### **Dapp moderation**
* Dapp review will be completed within 1-2 working days. * After passing the review, the platform will generate three types of promotion links based on your Dapp information, which developers can choose by themselves. * Review failed. Please adjust according to the reason for the failure and resubmit for review. ### Create Promotion Campaign #### Use Broearn information to create an ad serving account
First, you need to use the above information to open an account on the Facebook advertising platform (subject to what you see on your own platform page) #### **Create promotional links**
Click Create Promotion Link to enter the promotion link creation page. The same Dapp supports creating multiple promotion links.
1. **Broearn official information:** including Facebook App ID, Google Play download address, easy for you to quickly process or bind media delivery. 2. **Media placement:** Select media placement, support Facebook, Google Ads, Kwai, TikTok and other media. We take Facebook as an example to introduce the following process. 3. **Facebook Ad ID:** After selecting Facebook media, due to the requirements of Facebook media delivery, the advertiser and the application need to bind in both directions, so you need to fill in your Facebook Ad ID to bind. The binding result will be displayed in the promotion link list. 1. Once the binding is successful, you can start advertising. 2. If the binding fails, you need to resubmit your Facebook Ad ID or contact customer service to inquire about the reason for the failure. 4. **Landing page:** The default is Dapp Link URL, you can manually modify the landing page address. In order to distinguish different promotional links, we will add a lid field after your landing page URL to facilitate identification and tracking of landing page Advertising Effect. For example: if your landing page URL is [www.broearn.com](http://www.broearn.com), the corresponding generated landing page URL is [www.broearn.com](http://www.broearn.com) /? lid = 1. 5. **Event reporting method:** We provide two ways of Pixel tracking (recommended) and JS-SDK integration (need offline docking). 1. Pixel Tracking (Recommended - No Development Required) 1. On the Create Promotion Link page, fill in the Pixel tracking information. The Pixel information will be displayed in the generated promotion link, and the landing page URL will also have pixel information, which can be used for postback or reporting. 2. Pixel information naming supports customization. Please fill in the Pixel ID information accurately to avoid inaccurate data postback. After all the information is submitted, the promotion link can be generated. ### Promotion link type
We automatically generate two types of promotion links based on the landing page information you fill in, namely **Google play links (recommended) and deep links** . Developers can choose according to different promotion scenarios. * **Google play link:** * Google Play Store link with exclusive Dapp parameters. After users click it, they will be redirected to the Google Play Store to download and install Broearn. After installation, the Dapp Mini Program will be opened every time the application is launched. * > **Reference link format:** * Usage scenario: This link can be directly used for promotion and delivery on ad platforms such as Facebook Ads and TikTok Ads. After installation, opening it will be your Dapp Mini Program. The process is as follows: * Developer Workflow 1. Register and Login\ Dapp Developers Platform 2. Submit your Dapp\ and pass the review process 3. Fill in event reporting information\ (pixel or JS-SDK) 4. Automatically generate Dapp promotion links\ Copy and start advertising with just one click
* User Workflow 1. Click on a web advertisement (Facebook, TikTok, etc.) 2. Open Google Play and download/install the Broearn browser 3. Launch Broearn after installation and automatically open the Dapp mini-program 4. Report in-app events for precise optimization * **Deep link:** * Deep linking with independent Dapp parameters, supporting users who have installed Broearn to quickly start and automatically launch the Dapp Mini Program. * > **Reference link format:broearn://dapp?url=**[**https://game.broearn.com**](https://game.broearn.com)**?cid=Developer430\&lid=1\&pixel\_fb=123456789012345** * Usage scenario: After binding your Facebook Ad ID with Broearn, you can deliver through deep links in the Facebook backend.
### ### Data Dashboard
The Data Dashboard feature provides you with essential operational data and visualizations to assist in product data analysis and decision-making. Here's an overview of the key functionalities available: * Basic Operational Data: * Gain insights into key metrics such as total users, active users, sessions, and more. * Track and monitor important performance indicators related to your product. * Real-time Users: * View the real-time user count, allowing you to see the current number of active users engaging with your product. * Monitor user activity and engagement patterns as they occur. * User Trends Chart: * Visualize user trends over time with a graphical representation. * Identify patterns, peaks, and valleys in user activity to understand user behavior and make informed decisions. * User Retention Chart: * Analyze user retention rates and visualize how many users return to your product over a specified period. * Evaluate the effectiveness of your strategies in retaining users and identify areas for improvement. * User Distribution Map: * Explore the geographic distribution of your user base on an interactive map. * Understand where your users are located and identify potential target regions for marketing and expansion efforts. The Data Dashboard empowers you with valuable insights into your product's performance and user behavior. Leverage these tools to make data-driven decisions and optimize your product's success. ### Team Management
The Team Management feature allows you to efficiently manage and collaborate with your team members. Here's an overview of the key functionalities within this feature:
1. Inviting Team Members: * Invite team members by entering their email addresses. * The invited individuals will receive an invitation email and can join your team by following the instructions in the email.
2. Team Member Management: * Assign team roles to your members, defining their responsibilities and access levels. * Enable/disable team members' permissions as needed. * Remove team members from your team if necessary. * View basic information about team members, such as their names and contact details.
3. Role and Permission Management: * Create multiple roles within your team, each with different functional and data access permissions. * Customize the permissions granted to each role, allowing for flexible allocation of team roles. * Assign specific functionalities and data privileges to each role based on their respective responsibilities. With the Team Management feature, you can effectively organize your team, allocate roles and permissions, and facilitate collaboration within your project. This functionality ensures efficient teamwork and streamlined access control for enhanced productivity. ### Advertising Report ###
The Ad Campaign Report feature provides you with comprehensive data and statistics related to your advertising campaigns, specifically data sourced from Facebook. This report assists in analyzing and making data-driven decisions for your ad campaigns. Here are the key metrics included in the report: 1. Ad Spend: * Displays the total amount spent on your ad campaigns during a specific period. * Helps you track your advertising budget and expenses. 2. Exposure: * Shows the number of times your ads were shown or viewed by users. * Provides insights into the reach and visibility of your ad campaigns. 3. Ad Clicks: * Indicates the number of clicks your ads received from users. * Measures user engagement and interest in your ads. 4. CTR (Click-Through Rate): * Calculates the percentage of users who clicked on your ads after viewing them. * Helps assess the effectiveness and relevance of your ad content. 5. CPC ($) (Cost Per Click): * Represents the average cost incurred for each click on your ads. * Assists in evaluating the efficiency of your ad spending and campaign performance. 6. CPM (S) (Cost Per Mille): * Reflects the cost per 1,000 impressions of your ads. * Enables you to compare costs across different ad campaigns and advertising channels. 7. Install: * Tracks the number of app installations resulting from your ad campaigns. * Allows you to measure the success of your ads in driving user installations. The Ad Campaign Report provides you with valuable data for analyzing the performance and effectiveness of your advertising campaigns on Facebook. Utilize these statistics to optimize your ad strategies and make informed decisions to achieve your campaign objectives. ### User Analysis The User Analysis feature provides you with insights into your users' behaviors and activities, including their recent interactions, detailed information, user dynamics, user journey, and more. Specifically, the User Journey can be based on the event tracking associated with the creation of advertising campaign links. Here's how it works:
If you encounter any issues during the development process or need further assistance, refer to the support documentation available on the Broearn Developer Platform or reach out to our developer support team. # What are Dapp Developers? ## **Unleash Global Growth with Broearn's Empowering Ecosystem!** #### Global Reach, 100 Million Users: Expand your app's reach to millions of users across 60+ countries and regions, capturing the attention of a worldwide audience. #### Data-Driven Success: Gain valuable insights into user behavior, market trends, and growth opportunities through powerful data analytics. Make informed decisions and optimize your app for rapid growth. #### Maximize Ad ROI: Turbocharge your ad campaigns with integrated analysis and optimization features. Maximize your ad investment ROI, boost user conversion rates, and increase ad revenue. #### Empowering Ecosystem: Unlock the potential of blockchain and Web 3.0 wallet integration, empowering your app with innovative technologies for enhanced functionality and future-proofing. #### Unleash Global Traffic: Tap into Broearn's global traffic resources to propel your app to new heights. Capture new markets, seize growth opportunities, and thrive in the global app ecosystem. #### *Empowering a Robust Ecosystem* #### *Unleash Global Traffic and Thrive* #### *Unlock the Power of Blockchain and Web 3.0 Wallet Integration* ### **Broearn Developer - Pioneering the Era of App Development** App Distribution and Publishing: Let your app shine instantly! Broearn Developer offers unparalleled app distribution and publishing services, catapulting your app to the market and capturing the attention of global users. #### 📲 Millions of successfully published apps, covering 60+ countries and regions Data Analytics: Uncover user behavior and seize market trends! Broearn Developer provides powerful data analytics tools that empower you to gain profound insights into app usage, user feedback, and growth opportunities, enabling you to make informed decisions. #### 📊 Comprehensive app data analytics to help you optimize with precision and achieve rapid growth Ad Campaign Analysis: Unleash the potential of your ads and achieve breakthrough growth! With Broearn Developer's ad campaign analysis features, you gain full visibility into ad performance, optimize advertising strategies, and maximize user conversion rates and ad revenue. #### 💰 Precise ad campaign analysis to skyrocket your ad ROI Join Broearn Developer now to embark on a new era of app development! Experience seamless app distribution and publishing, dive deep into app data, unleash the potential of your ads, and achieve astonishing growth. # Introduction ## **Dapp Developers Platform Introduction** ### Broearn Developer Platform Enhanced Introduction: Welcome to the Broearn Developer Platform! We provide developers with a powerful toolkit designed to accelerate the success and promotion of DAPPs. Here are the key features and operational steps of our platform: ### Key Features: Quick Registration: With a simple registration process, you can swiftly create a Broearn Developer account and immediately start developing and promoting your DAPP. #### Streamlined DAPP Creation: We offer an intuitive interface and convenient tools to help you effortlessly create and manage DAPP projects. Fill in the relevant information, select categories and tags, and quickly create outstanding DAPPs. #### Powerful Ad Campaigns: By creating campaign links, you can advertise on the Broearn platform and reach a global audience. Set titles, descriptions, and target URLs, choose appropriate ad types and campaign settings to maximize ad effectiveness. #### Real-time Data Analysis: Through ad campaign data and the user data analytics dashboard, you can gain deep insights into ad performance and user behavior. View metrics such as impressions, clicks, conversion rates, optimize ad campaign strategies, and obtain information about user activity and retention rates. #### Collaborative Team Management: Our platform supports team management functionality, allowing you to invite team members, assign permissions and roles, and facilitate collaborative development and management of DAPP projects. ### **Product features** #### **Quick shelf:** Support Android quick shelf, shorten shelf time, save development costs, and make your application faster to market. #### **No need for review:** Skip the lengthy review process of the app store, not be restricted by third-party content, and solve the problem of apps being unable to be listed or difficult to list. #### **Global coverage:** multilingual adaptation, covering 200 countries and regions around the world, to meet your different traffic needs. #### **High-quality traffic pool:** **The** landing page advertising user pool is 6 times that of the application advertising user pool. With landing page media buying, the traffic pool is larger and the customer acquisition cost is reduced. #### **Traceable:** Support customized event reporting, all-round tracking distribution effect. # Disclaimer Disclaimer on Revenue, Deposits, and Withdrawals Revenue Generation 1. Revenue Sources Defined: The revenue generated for Dapp developers (hereinafter referred to as "Developers") on the Broearn Developer Platform () comes from the paid user deposits made through the platform's deposit services. Once a Dapp integrates and enables the deposit service, the Developer acknowledges and accepts the deposit service provided by the Broearn Developer Platform. The revenue earned by the Developer's Dapp product through the deposit service will be subject to the settlement requirements and rules of the Broearn Developer Platform, including the service fees associated with all third-party deposit channels accessed through the platform, which will be regularly reflected in the settlement statements. 2. Dapp Revenue: Developers can view their total order revenue, available balance, and detailed revenue information on the team account page. 3. Withdrawal Requests: Before initiating a withdrawal, Developers must carefully review their order revenue details to ensure the withdrawal amount matches their actual earnings. By submitting a withdrawal request, the Developer acknowledges that they have no disputes regarding the order revenue details and voluntarily proceed with the withdrawal. Withdrawals 1. Withdrawal Network and Wallet Address: Developers must ensure the withdrawal network and accurate wallet address information is provided. 2. Withdrawal Limits and Fees: The withdrawal amount cannot exceed the current available balance. The final net amount received will be calculated after deducting the applicable withdrawal fee, using the formula: Withdrawal Amount - Withdrawal Fee = Net Amount Received. 3. Withdrawal Request Verification: Before submitting a withdrawal request, Developers should double-check the accuracy of the withdrawal details, including the amount and wallet address. 4. Withdrawal Processing: Once a withdrawal request is submitted, it will undergo review, and the Developer will be notified by email upon completion. Disclaimer 1. Technical Risk Disclaimer: We will make our best efforts to ensure the stability and security of the platform system, but cannot guarantee it will be free from technical failures, network delays, hacker attacks, or other issues. Users should understand and accept these potential risks. 2. Withdrawal Accounts and Security: Users are responsible for ensuring the correct withdrawal wallet address is used. The company is not liable for any withdrawal failures or fund losses due to the use of incorrect wallet address information. 3. Legal Compliance: Users must comply with local laws and regulations when using the services. The company will cooperate with law enforcement agencies to protect the legitimate rights and interests of the platform and users. 4. Scope of Disclaimer: The company is not liable for any direct or indirect losses caused by user actions, including but not limited to losses resulting from unclear, illegal, or non-compliant operations. 5. Rights Reserved: The company reserves the right to adjust the withdrawal policies, rules, and revise this disclaimer as needed. Users should comply with the latest regulations and terms when using the services. This disclaimer applies to all services and functionalities of this platform. Please read and understand it carefully. Continued use of our services indicates your agreement and acceptance of the relevant content of this disclaimer. Thank you for your cooperation and understanding. We wish you a pleasant experience using our platform. If you have any questions or need further assistance, please feel free to contact us. # Develop Reference ### 1. Signature Verification #### 1.1 HTTP Header Parameters | Parameter Name | Parameter Type | Required | Description | | -------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | app\_id | string | Y | The key assigned by the system | | timestamp | number | Y | Seconds, difference from the server should not exceed 1h (1714492800) | | sign | string | Y | The signed string generated using the system-assigned secret key, the server will use the same rules to verify the validity of the request | #### 1.3 Request Body Specification Only JSON objects are supported, and all key-value pairs are of type string. #### 1.3 Signing Rules 1. Signing Secret: The secret corresponding to the api\_key 2. Signing Algorithm: HmacSHA1 3. Signing Content: ```txt 1. Concatenate timestamp and the assembled body content 2. The assembled body content structure is: Sort the keys in ascending order, take their values and concatenate, if the content is empty (multiple spaces, tabs are also considered empty, but this should be avoided as much as possible, when there is no data, do not pass this parameter), concatenate a space (If the parameter is a complex structure, such as JSON, it needs to be converted to a JSON string for processing) 3. If there are query parameters in the URL, these parameters will override the same key parameters in the body for signing 4. If the key is "sign", its value will not participate in the signing ``` For example: timestamp is 1694958440 The body content is: {"sign": "xxxxadqw", "ba":"ba\_content", "aa": "aa\_content", "cb": "\t \t (the \t here is a tab)"} The signing content would be: There is a space at the end (ignoring the double quotes) "1704959546aa\_contentba\_content " ### 2. Business Codes `🟡 Response code, not HTTP status code` | Code | Description | Remark | | ---- | ------------------------- | ------------------------------------------------------------------------------ | | 0 | Success | Y | | 419 | 'Api key status abnormal' | | | 420 | Invalid parameters | Missing required parameters (sign, timestamp) in the header or invalid api-key | | 421 | Invalid timestamp | Y | | 422 | Other unknown exceptions | | | 423 | Signature error | | ### 3. API #### 3.1 Client `Initiate in-app purchase flow` #### 3.2 Server **3.2.1 Order** **3.2.1.1 Order Details** * HTTP Request * GET * Query Parameters | Parameter Name | Parameter Type | Required | Description | | -------------- | -------------- | -------- | ----------------------------------------------------------------------------------- | | mer\_order\_id | string | Y | The order ID passed in by the dapp client (the order ID in the client's own system) | * The request body is empty * Response Body | Parameter Name | Parameter Type | Nullable | Content | Description | | -------------- | -------------- | -------- | ---------------------- | ---------------------- | | code | number | N | 0 | 0 - Request successful | | data | object (json) | Y | Order details instance | | * Order Details Instance Description | Parameter Name | Parameter Type | Nullable | Content | Description | | -------------- | -------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------- | | order\_id | string | N | Platform order ID | | | product\_id | string | N | Product ID | | | mer\_order\_id | string | N | Merchant order ID (the merchant must ensure uniqueness in their own system, the platform does not perform uniqueness validation) | | | product\_name | string | N | Product name | | | status | number | N | Order status, 1 - Success, 2 - Refunded | | | purchase\_time | number | N | Payment time, in milliseconds | | | refund\_time | number | Y | Refund time, valid when status is 2 | | | amount | number | N | Payment amount (micros, actual payment amount \* 10^6) | | | currency | number | N | Currency type (USD, etc.) | | | dapp\_id | number | N | The Dapp ID the order belongs to | | * Example Order Details Instance ```json { "order_id": "664d90293a2de71ad9f0", "mer_order_id": "5", "product_id": "test_product_id_1", "product_name": "test_name", "user_data": "xadauser", "status": 1, "purchase_time": 1715323679516, "refund_time": null, "amount": 0, "currency": "USD", "dapp_id": 384 } ``` #### 3.2.1.2 Order List * HTTP Request * GET * Query Parameters | Parameter Name | Parameter Type | Required | Description | | -------------- | -------------- | -------- | --------------------------------------------------------------------------------------------------------------- | | start\_time | number | Y | Start time, seconds (order payment time, greater than or equal to this time) | | end\_time | number | Y | End time, seconds (order payment time, less than this time) | | page\_num | number | Y | Pagination parameter, page number | | page\_size | number | Y | Pagination parameter, number of items per page, maximum 1000, over 1000 will be automatically processed as 1000 | | status | number | N | Order status, if not passed, it will query all statuses | | dapp\_id | number | N | Dapp ID, if not passed, it will query orders for all dapps under the organization | * The request body is empty * Response Body | Parameter Name | Parameter Type | Nullable | Content | Description | | -------------- | -------------- | -------- | ------------------- | ---------------------- | | code | number | N | 0 | 0 - Request successful | | data | object (json) | Y | Order data instance | | * Order Data Instance Description | Parameter Name | Parameter Type | Nullable | Content | | -------------- | -------------- | -------- | ------------------------------------- | | count | string | N | Total records for the query condition | | list | array (json) | Y | List of order detail instances | * Example Order Data Instance ```json { "count": 1, "list": [ { "order_id": "664eafe0c1b6ec2ca553", "mer_order_id": "5", "product_id": "test_product_id_1", "product_name": "Test Name", "user_data": "xadauser", "status": 2, "purchase_time": 1715323679516, "refund_time": 1716377660287, "amount": 0, "currency": "USD", "dapp_id": 382 } ] } ```