{"data":{"id":"614","string_id":"NoBvRK","status":"1","parent_id":"605","slug":"ER","order":"2","name":"Postback","type":"1","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","author":"","published_time":"1679627400","add_time":"1679627400","update_time":"1681788867","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","tags":[],"parent_name":"Integrated","parent_type":"1","parent_slug":"IG","child":[{"id":"616","string_id":"Nik9Lf","status":"1","parent_id":"614","slug":"NGqsGm","order":"3","name":"Registration Flow","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1679627627","add_time":"1679627627","update_time":"1721989702","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"616","content":"

Request Method<\/th>

Request Address<\/th><\/tr>

GET<\/td>

https:\/\/api.partnershare.net\/partner\/conversion<\/td><\/tr><\/tbody><\/table>

Parameter<\/span> <\/h2>
Parameter Name<\/th> Type<\/th> Required Fields<\/th> Instructions<\/th><\/tr>
conversion_token<\/td> string<\/td> yes<\/td> Return key provided by us<\/td><\/tr>
product_id<\/td> integer<\/td> yes<\/td> Product ID provided by us<\/td><\/tr>
ref<\/td> string<\/td> yes<\/td> Invitation code<\/td><\/tr>
source_user_id<\/td> string<\/td> yes<\/td> Invited user ID (must be unique)<\/td><\/tr>
conversion_type<\/td> integer<\/td> yes<\/td> Fixed value 1<\/td><\/tr>
source_user_info<\/td> string<\/td> no<\/td> Invited user information<\/td><\/tr>
session_id<\/td> string<\/td> no<\/td> Session id<\/td><\/tr><\/tbody><\/table>

<\/p>
Special Instructions<\/h5>
ref<\/strong><\/p>
If you need to be compatible with the old promotion website address, not our promotion website address, you can change the [ref] parameter to user_id, the value of the parameter is your company's user ID<\/p>

<\/p>
source_user_info<\/strong><\/p>
This value is for display to partners only. In general, send emails or mobile phones with , such as: test@qq.com or 138**229<\/p>

<\/p>
session_id<\/strong><\/p>
Session ID, the value of the parameter snid when you click \"promotion website address\" to jump to your \"registration page\". The \"Fraud Management\" will take effect only after the value is passed.<\/p>
$\"\u6587\u7ae0\u56fe\u7247\"$ <\/p>","pure_content":"Request Method Request Address GET https:\/\/api.partnershare.net\/partner\/conversion\n Parameter \n Parameter Name Type Required Fields Instructions conversion_token string yes Return key provided by us product_id integer yes Product ID provided by us ref string yes Invitation code source_user_id string yes Invited user ID (must be unique) conversion_type integer yes Fixed value 1 source_user_info string no Invited user information session_id string no Session id\n\n Special Instructions\n ref\nIf you need to be compatible with the old promotion website address, not our promotion website address, you can change the [ref] parameter to user_id, the value of the parameter is your company's user ID\n\nsource_user_info\nThis value is for display to partners only. In general, send emails or mobile phones with , such as: test@qq.com or 138****229\n\nsession_id\nSession ID, the value of the parameter snid when you click \"promotion website address\" to jump to your \"registration page\". The \"Fraud Management\" will take effect only after the value is passed.","is_draft":"0","editor_type":"1","file_path":"","add_time":"1679627627","update_time":"1679994523"},"pure_content":"Request Method Request Address GET https:\/\/api.partnershare.net\/partner\/conversion\n Parameter \n Parameter Name Type Required Fields Instructions conversion_token string yes Return key provided by us p"},{"id":"617","string_id":"So2PSb","status":"1","parent_id":"614","slug":"XfNcbX","order":"2","name":"Transaction Flow","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1679627641","add_time":"1679627641","update_time":"1721989703","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"617","content":"
Request Method<\/th> Request Address <\/th><\/tr>
GET<\/td> https:\/\/api.partnershare.net\/partner\/conversion<\/td><\/tr><\/tbody><\/table>
Parameter<\/span> <\/h2>
Parameter Name<\/th> Type<\/th> Required Fields<\/th> Instructions<\/th><\/tr>
conversion_token<\/td> string<\/td> yes<\/td> Return key provided by us <\/td><\/tr>
product_id<\/td> integer<\/td> yes<\/td> Product ID provided by us <\/td><\/tr>
ref<\/td> string<\/td> yes<\/td> Invitation code <\/td><\/tr>
source_user_id<\/td> string<\/td> yes<\/td> Invited user ID (must be unique) <\/td><\/tr>
conversion_type<\/td> integer<\/td> yes<\/td> Fixed value 2<\/td><\/tr>
transaction_id<\/td> string<\/td> yes<\/td> Transaction ID or order ID (must be unique)<\/td><\/tr>
total_money<\/td> number<\/td> yes<\/td> Total transaction amount<\/td><\/tr>
start_time_plan<\/td> integer<\/td> yes<\/td> Package start time, pass timestamp<\/td><\/tr>
amount_reward<\/td> number<\/td> no<\/td> Reward amount (this value is required only when the reward logic is set to program return)<\/td><\/tr>
number_of_reward<\/td> integer<\/td> no<\/td> When there are installments, this value needs to be passed (for example, if the user purchases for three months, the bonus will be issued in three months) <\/td><\/tr>
source_user_info<\/td> string<\/td> no<\/td> Invited user information<\/td><\/tr>
session_id<\/td> string<\/td> no<\/td> Session id<\/td><\/tr><\/tbody><\/table>
Special Instructions:<\/strong><\/h4>
ref<\/strong><\/p>
If you need to be compatible with the old promotion website address, not our promotion website address, you can change the [ref] parameter to user_id, the value of the parameter is your company's user ID<\/p>

<\/p>
source_user_info<\/strong><\/p>
This value is for display to partners only. In general, send emails or mobile phones with , such as: test@qq.com or 138****229<\/p>

<\/p>
session_id<\/strong><\/p>
Session ID, the value of the parameter snid when you click \"promotion website address\" to jump to your \"registration page\". The \"Fraud Management\" will take effect only after the value is passed. <\/p>
$\"\u6587\u7ae0\u56fe\u7247\"$ <\/p>","pure_content":"Request Method Request Address GET https:\/\/api.partnershare.net\/partner\/conversion\n Parameter \n Parameter Name Type Required Fields Instructions conversion_token string yes Return key provided by us product_id integer yes Product ID provided by us ref string yes Invitation code source_user_id string yes Invited user ID (must be unique) conversion_type integer yes Fixed value 2 transaction_id string yes Transaction ID or order ID (must be unique) total_money number yes Total transaction amount start_time_plan integer yes Package start time, pass timestamp amount_reward number no Reward amount (this value is required only when the reward logic is set to program return) number_of_reward integer no When there are installments, this value needs to be passed (for example, if the user purchases for three months, the bonus will be issued in three months) source_user_info string no Invited user information session_id string no Session id\n Special Instructions:\n ref\nIf you need to be compatible with the old promotion website address, not our promotion website address, you can change the [ref] parameter to user_id, the value of the parameter is your company's user ID\n\nsource_user_info\nThis value is for display to partners only. In general, send emails or mobile phones with , such as: test@qq.com or 138**229\n\nsession_id\nSession ID, the value of the parameter snid when you click \"promotion website address\" to jump to your \"registration page\". The \"Fraud Management\" will take effect only after the value is passed.","is_draft":"0","editor_type":"1","file_path":"","add_time":"1679627642","update_time":"1679994530"},"pure_content":"Request Method Request Address GET https:\/\/api.partnershare.net\/partner\/conversion\n Parameter \n Parameter Name Type Required Fields Instructions conversion_token string yes Return key provided by u"},{"id":"128644","string_id":"IoegMu","status":"1","parent_id":"614","slug":"Shopify-App-Integration-Guide","order":"1","name":"Shopify App Integration Guide","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1721989704","add_time":"1721976516","update_time":"1721989704","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"2","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"128644","content":"# Integrating with Shopify in Two Steps\n\nFollow the instructions below to complete the integration.\n\n## Step 1: Add Products\n\nWhen you first register and subsequently add products, you can operate \"Add Product\" in the upper left corner.\n\n![](https:\/\/resource-wangsu.helplook.net\/docker_production\/gnls32\/article\/Wk9laG\/66a343ea422c2.png)\n\n### Product Form Filling Guide\n\n- Product logo: The logo displayed in the PartnerShare promotion market.\n- Product name: The name displayed in the PartnerShare promotion market.\n- Settlement currency with PartnerShare: USD.\n- Product type: Shopify plugin\n- Shopify App Store Listing Link: e.g., https:\/\/apps.shopify.com\/YourApp\n- Shopify Partner ID: Find it in the Shopify Partners backend under \"Settings\" -> \"Partner API Clients\".\n\n![](https:\/\/resource-wangsu.helplook.net\/docker_production\/gnls32\/article\/cy9rDR\/66a1ccd57a5fc.png)\n\n### Shopify Partner API Client Access Token\n\n> Important! PartnerShare platform requires API permissions for your application so we can determine if the installation was done via a promotion link and accurately calculate transaction and reward amounts.\n> These permissions grant us \"read-only\" access, and we only use this access to read information related to the PartnerShare platform.\n> We will not read any data prior to your integration with PartnerShare.\n> You can find more information about partner API permissions [here](https:\/\/shopify.dev\/api\/partner\/getting-started#permissions).\n\nIf you are creating an API client access token for the first time, you can follow the guide and screenshots below to obtain the API client access token:\n\n1. In the Shopify Partners backend, find it under \"Settings\" -> \"Partner API Clients\".\n2. Create an API client and check the permissions for Financial Information and Manage Apps.\n3. Obtain the access token and fill it into the product information.\n\n![](https:\/\/resource-wangsu.helplook.net\/docker_production\/gnls32\/article\/Wk9laG\/66a34522213f7.png)\n![](https:\/\/resource-wangsu.helplook.net\/docker_production\/gnls32\/article\/Wk9laG\/66a34540684bb.png)\n![](https:\/\/resource-wangsu.helplook.net\/docker_production\/gnls32\/article\/Wk9laG\/66a345bc0b36e.png)\n![](https:\/\/resource-wangsu.helplook.net\/docker_production\/gnls32\/article\/Wk9laG\/66a345d18f051.png)\n\n### Shopify App ID\n\nFind and copy it from the link on your application's partner management page.\n\nFor example:\n\nhttps:\/\/partners.shopify.com\/1111111\/apps\/1234567\/#\n\n1234567 is your application ID.\n\n### Verify API Connection\n\nTo successfully create the app and start promoting, you must verify the connection with the Shopify Partners API to ensure the details you entered are correct.\n\nIf the above steps are correct, click the verification link on Partnershare, and after passing, click submit. If prompted submission is successful, the first step of the integration is completed!\n\n## Step 2: POST Request\n\nTo complete the integration, you need to add a POST request to your application. This request will help us correctly match invited users to their respective partners.\n\n> This request must run each time a new store installs the application.\n\n### Add the Code to Your Application\n\nWhen OAuth is completed, you will receive a request from Shopify containing the shop name and the \"X-Forwarded-For\" header.\n\nWhen you have these values, you need to send a POST request containing the following data (four parameters in total):\n\n- conversion_token\n- shop_name\n- app_id\n- xff\n\n### Parameter Explanation\n\n- conversion_token: PartnerShare data return key. Path: PartnerShare backend -> Advanced Setting -> Integrated.\n- shop_name: The store name of the currently logged-in application. (Full name, e.g., newshop.myshopify.com).\n- app_id: Your Shopify application's ID. To find it, go to the app's partner management page and copy it from the URL link. For example: \"https:\/\/partners.shopify.com\/1111111\/apps\/1234567#\/\", 1234567 is your app ID.\n- xff: Shopify request header value 'X-Forwarded-For'.\n\n### Request Header Value Examples in Different Languages\n\n- node: `ctx.request.header['x-forwarded-for']`\n- ruby: `request.env[\"HTTP_X_FORWARDED_FOR\"]`\n- PHP: `$_SERVER[\"HTTP_X_FORWARDED_FOR\"]`\n\n### Curl Request Example\n\n```shell\ncurl -X POST https:\/\/api.partnershare.net\/partner\/conversion\/new-merchant\n -H 'Content-Type: application\/json'\n -d '{\"conversion_token\":\"xxxxxx\",\n \"shop_name\":\"xxxxxxx.myshopify.com\",\n \"app_id\":\"1111111\",\n \"xff\":\"11.1111.111.111\"}'\n```\n\n### Node.js Request Example\n\n```node\nawait fetch('https:\/\/api.partnershare.net\/partner\/conversion\/new-merchant', { \n method: 'POST', \n headers: { 'Content-Type': 'application\/json' }, \n body: JSON.stringify({ conversion_token: \"xxxxxx\", shop_name: \"xxxxx.myshopify.com\", app_id: \"111111\", xff: \"11.1111.111.111\" }) \n})\n```\n\n### Test the Request\n\nYou can test it directly on PartnerShare, and later you can contact our staff to clear the test data.\n\n### Initiate the Request\n\nAfter adding the POST request, you need to open a new developer store from the application's partner management backend, install, and open your application. Once our system receives the request for the first time, the product integration status will change to \"Under Review,\" and our account manager will contact you.\n\n### Integration Status\n\n- Integrating: The connection to the Partner API is successful. The POST request is still needed.\n- Under Review: We have received the POST request. Your application is under review, and our account manager will contact you once it is approved.","pure_content":"Integrating with Shopify in Two Steps\nFollow the instructions below to complete the integration.\nStep 1: Add Products\nWhen you first register and subsequently add products, you can operate \"Add Product\" in the upper left corner.\n\nProduct Form Filling Guide\n\n\nProduct logo: The logo displayed in the PartnerShare promotion market.\n\nProduct name: The name displayed in the PartnerShare promotion market.\n\nSettlement currency with PartnerShare: USD.\n\nProduct type: Shopify plugin\n\nShopify App Store Listing Link: e.g., https:\/\/apps.shopify.com\/YourApp\n\nShopify Partner ID: Find it in the Shopify Partners backend under \"Settings\" -> \"Partner API Clients\".\n\n\nShopify Partner API Client Access Token\n\nImportant! PartnerShare platform requires API permissions for your application so we can determine if the installation was done via a promotion link and accurately calculate transaction and reward amounts.\nThese permissions grant us \"read-only\" access, and we only use this access to read information related to the PartnerShare platform.\nWe will not read any data prior to your integration with PartnerShare.\nYou can find more information about partner API permissions here.\n\nIf you are creating an API client access token for the first time, you can follow the guide and screenshots below to obtain the API client access token:\n\nIn the Shopify Partners backend, find it under \"Settings\" -> \"Partner API Clients\".\nCreate an API client and check the permissions for Financial Information and Manage Apps.\nObtain the access token and fill it into the product information.\n\n\n\n\n\nShopify App ID\nFind and copy it from the link on your application's partner management page.\nFor example:\nhttps:\/\/partners.shopify.com\/1111111\/apps\/1234567\/#\n1234567 is your application ID.\nVerify API Connection\nTo successfully create the app and start promoting, you must verify the connection with the Shopify Partners API to ensure the details you entered are correct.\nIf the above steps are correct, click the verification link on Partnershare, and after passing, click submit. If prompted submission is successful, the first step of the integration is completed!\nStep 2: POST Request\nTo complete the integration, you need to add a POST request to your application. This request will help us correctly match invited users to their respective partners.\n\nThis request must run each time a new store installs the application.\n\nAdd the Code to Your Application\nWhen OAuth is completed, you will receive a request from Shopify containing the shop name and the \"X-Forwarded-For\" header.\nWhen you have these values, you need to send a POST request containing the following data (four parameters in total):\n\nconversion_token\nshop_name\napp_id\nxff\n\nParameter Explanation\n\n\nconversion_token: PartnerShare data return key. Path: PartnerShare backend -> Advanced Setting -> Integrated.\n\nshop_name: The store name of the currently logged-in application. (Full name, e.g., newshop.myshopify.com).\n\napp_id: Your Shopify application's ID. To find it, go to the app's partner management page and copy it from the URL link. For example: \"https:\/\/partners.shopify.com\/1111111\/apps\/1234567#\/\", 1234567 is your app ID.\n\nxff: Shopify request header value 'X-Forwarded-For'.\n\nRequest Header Value Examples in Different Languages\n\nnode: ctx.request.header['x-forwarded-for']\n\nruby: request.env[\"HTTP_X_FORWARDED_FOR\"]\n\nPHP: $_SERVER[\"HTTP_X_FORWARDED_FOR\"]\n\n\nCurl Request Example\ncurl -X POST https:\/\/api.partnershare.net\/partner\/conversion\/new-merchant\n -H 'Content-Type: application\/json'\n -d '{\"conversion_token\":\"xxxxxx\",\n \"shop_name\":\"xxxxxxx.myshopify.com\",\n \"app_id\":\"1111111\",\n \"xff\":\"11.1111.111.111\"}'\n\nNode.js Request Example\nawait fetch('https:\/\/api.partnershare.net\/partner\/conversion\/new-merchant', { \n method: 'POST', \n headers: { 'Content-Type': 'application\/json' }, \n body: JSON.stringify({ conversion_token: \"xxxxxx\", shop_name: \"xxxxx.myshopify.com\", app_id: \"111111\", xff: \"11.1111.111.111\" }) \n})\n\nTest the Request\nYou can test it directly on PartnerShare, and later you can contact our staff to clear the test data.\nInitiate the Request\nAfter adding the POST request, you need to open a new developer store from the application's partner management backend, install, and open your application. Once our system receives the request for the first time, the product integration status will change to \"Under Review,\" and our account manager will contact you.\nIntegration Status\n\n\nIntegrating: The connection to the Partner API is successful. The POST request is still needed.\n\nUnder Review: We have received the POST request. Your application is under review, and our account manager will contact you once it is approved.","is_draft":"0","editor_type":"2","file_path":"","add_time":"1721976516","update_time":"1721989704"},"pure_content":"Integrating with Shopify in Two Steps\nFollow the instructions below to complete the integration.\nStep 1: Add Products\nWhen you first register and subsequently add products, you can operate \"Add Produc"}],"content":{"icon":"\/docker_production\/rlor5p\/content_icon\/NoBvRK","desc":"","content_id":"614","add_time":"1679627401","update_time":"1681788867","content":"","is_traffic_less":"0","file_type":""},"hot_list":[],"user_read_num":"0","is_auth":"0"},"msg":"Success","code":200}