{"data":{"id":"76398","string_id":"2nYtXP","status":"1","parent_id":"0","slug":"h8XHF8","order":"6","name":"Open API Guide","type":"1","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","author":"","published_time":"1709722583","add_time":"1709721743","update_time":"1775027785","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","tags":[],"child":[{"id":"76399","string_id":"gB01mu","status":"1","parent_id":"76398","slug":"Demo","order":"9","name":"Demo","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1709722583","add_time":"1709721744","update_time":"1755655965","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"76399","content":"

Request Demo<\/span><\/h4>\n\n\n\n\n\n\n\n\n

Language<\/span><\/th>\n Demo<\/span><\/th>\n<\/tr>\n<\/thead>\n

Go<\/span><\/td>\n Click to view<\/a><\/span><\/td>\n<\/tr>\n

Java<\/span><\/td>\n Click to view<\/a><\/span><\/td>\n<\/tr>\n

PHP<\/span><\/td>\n Click to view<\/a><\/span><\/td>\n<\/tr>\n

Python<\/span><\/td>\n

Click to view<\/a><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Device Report Parse Demo<\/span><\/h4>\n\n\n\n\n\n

Language<\/span><\/th>\n Demo<\/span><\/th>\n<\/tr>\n<\/thead>\n

Java<\/span><\/td>\n

Click to view<\/a><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>","pure_content":"Request Demo\n\n\n\nLanguage\nDemo\n\n\n\n\nGo\nClick to view\n\n\nJava\nClick to view\n\n\nPHP\nClick to view\n\n\nPython\nClick to view\n\n\n\nDevice Report Parse Demo\n\n\n\nLanguage\nDemo\n\n\n\n\nJava\nClick to view","is_draft":"0","editor_type":"1","file_path":"","add_time":"1709721745","update_time":"1748605240"},"pure_content":"Request Demo\n\n\n\nLanguage\nDemo\n\n\n\n\nGo\nClick to view\n\n\nJava\nClick to view\n\n\nPHP\nClick to view\n\n\nPython\nClick to view\n\n\n\nDevice Report Parse Demo\n\n\n\nLanguage\nDemo\n\n\n\n\nJava\nClick to view"},{"id":"76400","string_id":"huOXuM","status":"1","parent_id":"76398","slug":"Authentication","order":"8","name":"Authentication","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1709722583","add_time":"1709721745","update_time":"1755655965","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"76400","content":"

note: Examples of signatures in different languages\uff1a<\/span><\/span><\/span><\/h3>\n
Refer to the signature implementation logic in the demo code\uff1a<\/span><\/span><\/span>demo<\/span><\/span><\/span><\/a><\/p>\n

1 The process description of API request<\/span><\/h3>\n

The server compares the expected signature with the signed key that sent by the client.If they are entirely consistent with eachother, the request can pass the security verification.Otherwise, it will be rejected.<\/span><\/li>\n<\/ul>\n

2 Header general request params<\/span><\/h3>\n\n\n\n\n\n\n

params<\/span><\/strong><\/td>\n notes<\/span><\/strong><\/td>\n sample<\/span><\/strong><\/td>\n<\/tr>\n

X-Up-Key<\/span><\/td>\n publisher_key<\/span><\/td>\n X-Up-Key: i8XNjC4b8KVok4uw5RftR38Wgp2BFwql<\/span><\/td>\n<\/tr>\n

X-Up-Timestamp<\/span><\/td>\n Unix timestamp(ms), the millisecond from 1970\/1\/1. Valid duration is 15 minutes.<\/span><\/td>\n 1562813567000<\/span><\/td>\n<\/tr>\n

X-Up-Signature<\/span><\/td>\n

signature string<\/span><\/td>\n

<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

3.3 Params to create signature<\/span><\/h3>\n\n\n\n\n\n\n\n\n

params<\/span><\/strong><\/td>\n notes<\/span><\/strong><\/td>\n sample<\/span><\/strong><\/td>\n<\/tr>\n

Content-MD5<\/span><\/td>\n MD5 from HTTP Body string\uff08upper letters\uff09<\/span><\/td>\n 875264590688CA6171F6228AF5BBB3D2<\/span><\/td>\n<\/tr>\n

Content-Type<\/span><\/td>\n type of HTTP Body<\/span><\/td>\n application\/json<\/span><\/td>\n<\/tr>\n

Headers<\/span><\/td>\n Headers except X-Up-Signature<\/span><\/td>\n X-Up-Timestamp:1562813567000 X-Up-Key:aac6880633f102bce2174ec9d99322f55e69a8a2<\/span><\/td>\n<\/tr>\n

HTTPMethod<\/span><\/td>\n HTTP method(upper letters)<\/span><\/td>\n PUT\u3001GET\u3001POST<\/span><\/td>\n<\/tr>\n

Resource Path<\/span><\/td>\n

strings from HTTP path<\/span><\/td>\n

\/v1\/fullreport<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

3.4 Create signature<\/a><\/span><\/h3>\n

Create signature string\uff1a<\/span><\/p>\n

     <\/span><\/pre>\nSignString = HTTPMethod + \"\\n\" \n                        \\+ Content-MD5 + \"\\n\" \n                        \\+ Content-Type + \"\\n\"  \n                        \\+ Headers + \"\\n\"\n                        \\+ Resource \n\nMD5Result = MD5(SignString)\n\nX-Up-Signature = ToUpper(MD5Result)\n<\/code><\/pre>\nResource:<\/span><\/p>\n
    <\/span><\/pre>\nURL Path and query params<\/code><\/pre>\nHeaders\uff1a<\/span><\/p>\n
   <\/span><\/pre>\n\/\/ X-Up-Key + X-Up-Timestamp (sort by first letter)\n\/\/ except X-Up-Signature \nHeaders = Key1 + \":\" + Value1 + '\\n' + Key2 + \":\" + Value2   \n<\/code><\/pre>\nServer will create sign and campare the sign with X-Up-Signature<\/span><\/p>","pure_content":"note: Examples of signatures in different languages\uff1a\nRefer to the signature implementation logic in the demo code\uff1ademo\n1 The process description of API request\n\nThe client generates a key based on the content of the API request, including the HTTP headers and bodies.\nThe client uses MD5 to sign on the key that generated in the first step.\nThe client sends the API request content along with the signed key to the server.\nAfter receiving the request, the server repeats the above first and second steps and calculates the expected signature at the server.\nThe server compares the expected signature with the signed key that sent by the client.If they are entirely consistent with eachother, the request can pass the security verification.Otherwise, it will be rejected.\n\n2 Header general request params\n\n\n\nparams\nnotes\nsample\n\n\nX-Up-Key\npublisher_key\nX-Up-Key: i8XNjC4b8KVok4uw5RftR38Wgp2BFwql\n\n\nX-Up-Timestamp\nUnix timestamp(ms), the millisecond from 1970\/1\/1. Valid duration is 15 minutes.\n1562813567000\n\n\nX-Up-Signature\nsignature string\n \n\n\n\n3.3 Params to create signature\n\n\n\nparams\nnotes\nsample\n\n\nContent-MD5\nMD5 from HTTP Body string\uff08upper letters\uff09\n875264590688CA6171F6228AF5BBB3D2\n\n\nContent-Type\ntype of HTTP Body\napplication\/json\n\n\nHeaders\nHeaders except X-Up-Signature\nX-Up-Timestamp:1562813567000 X-Up-Key:aac6880633f102bce2174ec9d99322f55e69a8a2\n\n\nHTTPMethod\nHTTP method(upper letters)\nPUT\u3001GET\u3001POST\n\n\nResource Path\nstrings from HTTP path\n\/v1\/fullreport\n\n\n\n3.4 Create signature\nCreate signature string\uff1a\n     \nSignString = HTTPMethod + \"\\n\" \n                        \\+ Content-MD5 + \"\\n\" \n                        \\+ Content-Type + \"\\n\"  \n                        \\+ Headers + \"\\n\"\n                        \\+ Resource \n\nMD5Result = MD5(SignString)\n\nX-Up-Signature = ToUpper(MD5Result)\n\nResource:\n    \nURL Path and query params\nHeaders\uff1a\n   \n\/\/ X-Up-Key + X-Up-Timestamp (sort by first letter)\n\/\/ except X-Up-Signature \nHeaders = Key1 + \":\" + Value1 + '\\n' + Key2 + \":\" + Value2   \n\nServer will create sign and campare the sign with X-Up-Signature","is_draft":"0","editor_type":"1","file_path":"","add_time":"1709721746","update_time":"1748605240"},"pure_content":"note: Examples of signatures in different languages\uff1a\nRefer to the signature implementation logic in the demo code\uff1ademo\n1 The process description of API request\n\nThe client generates a key based on the"},{"id":"76401","string_id":"uIx6Sx","status":"1","parent_id":"76398","slug":"Error-Code","order":"7","name":"Error Code","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1709722584","add_time":"1709721746","update_time":"1755655965","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"76401","content":"
 Response HTTP code<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\nHTTP code<\/strong><\/td>\n response message<\/strong><\/td>\n notes<\/strong><\/td>\n<\/tr>\n
200<\/td>\n -<\/td>\n success<\/td>\n<\/tr>\n
500<\/td>\n -<\/td>\n general exception<\/td>\n<\/tr>\n
600<\/td>\n StatusHeaderParamError<\/td>\n request Header params error<\/td>\n<\/tr>\n
601<\/td>\n StatusSign<\/td>\n Sign error<\/td>\n<\/tr>\n
602<\/td>\n StatusParam<\/td>\n params error<\/td>\n<\/tr>\n
603<\/td>\n StatusPublisherRestrict<\/td>\n no authentication<\/td>\n<\/tr>\n
604<\/td>\n StatusAppLengthError<\/td>\n App creation error<\/td>\n<\/tr>\n
605<\/td>\n StatusRpcParamError<\/td>\n base Server error<\/td>\n<\/tr>\n
606<\/td>\n StatusRequestRepeatError<\/td>\n duplicated requests<\/td>\n<\/tr>\n<\/tbody>\n<\/table>","pure_content":" Response HTTP code\n\n\n\nHTTP code\nresponse message\nnotes\n\n\n200\n-\nsuccess\n\n\n500\n-\ngeneral exception\n\n\n600\nStatusHeaderParamError\nrequest Header params error\n\n\n601\nStatusSign\nSign error\n\n\n602\nStatusParam\nparams error\n\n\n603\nStatusPublisherRestrict\nno authentication\n\n\n604\nStatusAppLengthError\nApp creation error\n\n\n605\nStatusRpcParamError\nbase Server error\n\n\n606\nStatusRequestRepeatError\nduplicated requests","is_draft":"0","editor_type":"1","file_path":"","add_time":"1709721747","update_time":"1748605240"},"pure_content":" Response HTTP code\n\n\n\nHTTP code\nresponse message\nnotes\n\n\n200\n-\nsuccess\n\n\n500\n-\ngeneral exception\n\n\n600\nStatusHeaderParamError\nrequest Header params error\n\n\n601\nStatusSign\nSign error\n\n\n602\nStatus"},{"id":"76402","string_id":"cmWUV2","status":"1","parent_id":"76398","slug":"Management-API","order":"6","name":"Management API","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1709722584","add_time":"1709721748","update_time":"1755681518","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"76402","content":"1.Change Log<\/h1>\n\n\n\n\n\n\n\n\n\n\nversion<\/th>\n date<\/th>\n notes<\/th>\n<\/tr>\n<\/thead>\n
v 2.4<\/td>\n 2021\/3\/18<\/td>\n Return the ecpm price by account currency, support the creation of custom network ad sources and upload network data<\/td>\n<\/tr>\n
v 2.3<\/td>\n 2020\/8\/20<\/td>\n supports Huawei\u3001Google Ad Manager<\/td>\n<\/tr>\n
v 2.2<\/td>\n 2020\/5\/14<\/td>\n segments function adjustment<\/td>\n<\/tr>\n
v 2.1<\/td>\n 2020\/3\/16<\/td>\n supports network and adsources<\/td>\n<\/tr>\n
v 2.0<\/td>\n 2019\/11\/4<\/td>\n supports waterfall and segments<\/td>\n<\/tr>\n
v 1.0<\/td>\n 2019\/7\/17<\/td>\n supports apps and placements<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n1. Introduction<\/h1>\nIn order to improve the monetization efficiency of publishers, TopOn provides API with developers' background-related operations, such as creating app and placements, changing Waterfall priorities and so on. This document is the detailed instruction of API. If you need any assistance, please feel free to reach us. Thank you!<\/p>\n
 <\/p>","pure_content":"1.Change Log\n\n\n\nversion\ndate\nnotes\n\n\n\n\nv 2.4\n2021\/3\/18\nReturn the ecpm price by account currency, support the creation of custom network ad sources and upload network data\n\n\nv 2.3\n2020\/8\/20\nsupports Huawei\u3001Google Ad Manager\n\n\nv 2.2\n2020\/5\/14\nsegments function adjustment\n\n\nv 2.1\n2020\/3\/16\nsupports network and adsources\n\n\nv 2.0\n2019\/11\/4\nsupports waterfall and segments\n\n\nv 1.0\n2019\/7\/17\nsupports apps and placements\n\n\n\n1. Introduction\nIn order to improve the monetization efficiency of publishers, TopOn provides API with developers' background-related operations, such as creating app and placements, changing Waterfall priorities and so on. This document is the detailed instruction of API. If you need any assistance, please feel free to reach us. Thank you!\n ","is_draft":"0","editor_type":"1","file_path":"","add_time":"1709721749","update_time":"1748605240"},"pure_content":"1.Change Log\n\n\n\nversion\ndate\nnotes\n\n\n\n\nv 2.4\n2021\/3\/18\nReturn the ecpm price by account currency, support the creation of custom network ad sources and upload network data\n\n\nv 2.3\n2020\/8\/20\nsupports H"},{"id":"76410","string_id":"6KwVr6","status":"1","parent_id":"76398","slug":"Reporting-API","order":"4","name":"Reporting API","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1709722586","add_time":"1709721759","update_time":"1755655966","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"3","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"76410","content":"
1.Change Log<\/span><\/h2>\n\n\n\n\n\n\n\n\n\nversion<\/span><\/th>\n date<\/span><\/th>\n notes<\/span><\/th>\n<\/tr>\n<\/thead>\n
v 2.3<\/span><\/td>\n 2021\/3\/18<\/span><\/td>\n return data such as estimated revenue, estimated ecpm etc.<\/span><\/td>\n<\/tr>\n
v 2.2<\/span><\/td>\n 2020\/5\/15<\/span><\/td>\n return ad source ID,LTV and retention support to return 1 to 60 days data<\/span><\/td>\n<\/tr>\n
v 2.1<\/span><\/td>\n 2020\/3\/17<\/span><\/td>\n update full report metrics<\/span><\/td>\n<\/tr>\n
v 2.0<\/span><\/td>\n 2019\/8\/30<\/span><\/td>\n supports LTV & retention report<\/span><\/td>\n<\/tr>\n
v 1.0<\/span><\/td>\n 2019\/7\/17<\/span><\/td>\n supports full report<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n2. Introduction<\/span><\/h2>\nIn order to improve the monetization efficiency of publishers, Taku provides API for data report, which can query comprehensive report, LTV & retention report and other data. This document is the detailed instruction of API. If you need any assistance, please feel free to reach us. Thank you!<\/span><\/p>\n
\u3010Notices\u3011<\/span><\/p>\n
• The number of parallel requests for a single user does not exceed 3<\/span><\/p>\n
• Developers must use serial pull for timing tasks to avoid triggering the Taku current limiting mechanism during parallel pulls and causing pull failures<\/span><\/p>\n
• Developers' scheduled tasks should avoid starting at the three time periods of the hour, half hour, and 20-25 minutes.<\/span><\/p>","pure_content":"1.Change Log\n\n\n\n version\n date\n notes\n\n\n\n\n v 2.3\n 2021\/3\/18\n return data such as estimated revenue, estimated ecpm etc.\n\n\n v 2.2\n 2020\/5\/15\n return ad source ID,LTV and retention support to return 1 to 60 days data\n\n\n v 2.1\n 2020\/3\/17\n update full report metrics\n\n\n v 2.0\n 2019\/8\/30\n supports LTV & retention report\n\n\n v 1.0\n 2019\/7\/17\n supports full report\n\n\n\n2. Introduction\nIn order to improve the monetization efficiency of publishers, Taku provides API for data report, which can query comprehensive report, LTV & retention report and other data. This document is the detailed instruction of API. If you need any assistance, please feel free to reach us. Thank you!\n\u3010Notices\u3011\n\u2022 The number of parallel requests for a single user does not exceed 3\n\u2022 Developers must use serial pull for timing tasks to avoid triggering the Taku current limiting mechanism during parallel pulls and causing pull failures\n\u2022 Developers' scheduled tasks should avoid starting at the three time periods of the hour, half hour, and 20-25 minutes.","is_draft":"0","editor_type":"3","file_path":"","add_time":"1709721760","update_time":"1755225694"},"pure_content":"1.Change Log\n\n\n\n version\n date\n notes\n\n\n\n\n v 2.3\n 2021\/3\/18\n return data such as estimated revenue, estimated ecpm etc.\n\n\n v 2.2\n 2020\/5\/15\n return ad source ID,LTV and retention support to return 1 t"},{"id":"76414","string_id":"pCYJqR","status":"1","parent_id":"76398","slug":"Device-Reporting-API","order":"3","name":"Device Reporting API","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1709722588","add_time":"1709721765","update_time":"1755655966","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"76414","content":"
1.Change Log<\/h2>\n\n\n\n\n\n\n\n\nversion<\/th>\n date<\/th>\n notes<\/th>\n<\/tr>\n<\/thead>\n
v 1.3<\/td>\n 2021\/7\/14<\/td>\n Response supports os_version\uff0catt_status<\/td>\n<\/tr>\n
v 1.2<\/td>\n 2020\/5\/16<\/td>\n supports abtest and segment dimension<\/td>\n<\/tr>\n
v 1.1<\/td>\n 2020\/3\/17<\/td>\n supports currency and timezone<\/td>\n<\/tr>\n
v 1.0<\/td>\n 2019\/8\/29<\/td>\n supports device report<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n2. Introduction<\/h2>\nIn order to improve the monetization efficiency of publishers, TopOn provides the API for device dimension data reporting, which can understand the monetization of each device in detail and realize fine operation. This document is the detailed instruction of API. If you need any assistance, please feel free to reach us. Thank you!<\/p>","pure_content":"1.Change Log\n\n\n\nversion\ndate\nnotes\n\n\n\n\nv 1.3\n2021\/7\/14\nResponse supports os_version\uff0catt_status\n\n\nv 1.2\n2020\/5\/16\nsupports abtest and segment dimension\n\n\nv 1.1\n2020\/3\/17\nsupports currency and timezone\n\n\nv 1.0\n2019\/8\/29\nsupports device report\n\n\n\n2. Introduction\nIn order to improve the monetization efficiency of publishers, TopOn provides the API for device dimension data reporting, which can understand the monetization of each device in detail and realize fine operation. This document is the detailed instruction of API. If you need any assistance, please feel free to reach us. Thank you!","is_draft":"0","editor_type":"1","file_path":"","add_time":"1709721766","update_time":"1748605240"},"pure_content":"1.Change Log\n\n\n\nversion\ndate\nnotes\n\n\n\n\nv 1.3\n2021\/7\/14\nResponse supports os_version\uff0catt_status\n\n\nv 1.2\n2020\/5\/16\nsupports abtest and segment dimension\n\n\nv 1.1\n2020\/3\/17\nsupports currency and timezone"},{"id":"76417","string_id":"JQZ2VO","status":"1","parent_id":"76398","slug":"Appendix","order":"1","name":"Appendix","type":"2","cover":"","cover_alt":"","desc":"","website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1709722588","add_time":"1709721769","update_time":"1755772881","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"76417","content":"","pure_content":"","is_draft":"0","editor_type":"1","file_path":"","add_time":"1709721770","update_time":"1709722588"},"pure_content":""},{"id":"598741","string_id":"oksSfqCT","status":"1","parent_id":"76398","slug":"oksSfqCT","order":"0","name":"QA","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"\u5b87\u529b","published_time":"1756115407","add_time":"1755768316","update_time":"1756115407","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"3","file_type":"","auth_id":"[\"-1\"]","content":{"content_id":"598741","content":"","pure_content":"","is_draft":"0","editor_type":"3","file_path":"","add_time":"1755768316","update_time":"1756115407"},"pure_content":""}],"content":{"icon":"","desc":"","content_id":"76398","add_time":"1709721743","update_time":"1709722583","content":"","is_traffic_less":"0","file_type":""},"hot_list":[],"user_read_num":"0","is_auth":"0"},"msg":"Success","code":200}

note: Examples of signatures in different languages\uff1a<\/span><\/span><\/span><\/h3>\nRefer to the signature implementation logic in the demo code\uff1a<\/span><\/span><\/span>demo<\/span><\/span><\/span><\/a><\/p>\n

note: Examples of signatures in different languages\uff1a<\/span><\/span><\/span><\/h3>\n
Refer to the signature implementation logic in the demo code\uff1a<\/span><\/span><\/span>demo<\/span><\/span><\/span><\/a><\/p>\n