{"id":2600,"date":"2023-08-10T10:37:28","date_gmt":"2023-08-10T02:37:28","guid":{"rendered":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-screenshot\/"},"modified":"2024-12-04T15:26:15","modified_gmt":"2024-12-04T07:26:15","slug":"api-screenshot","status":"publish","type":"docs","link":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-screenshot\/","title":{"rendered":"API ScreenShot"},"content":{"rendered":"\n

API ScreenShot:<\/strong><\/p>\n\n\n\n


<\/p>\n\n\n\n

Request Url: <\/p>\n\n\n\n


<\/p>\n\n\n\n

http:\/\/127.0.0.1:35000\/api\/v1\/profile\/ScreenShot<\/mark><\/code><\/pre>\n\n\n\n

<\/p>\n\n\n\n
Request Type: POST<\/p>\n\n\n\n

<\/p>\n\n\n\n
Name<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td>required<\/strong><\/td><\/tr>
profileId<\/td>string<\/td>Browser profile ID<\/td>true<\/td><\/tr>
body<\/td>string<\/td>Absolute path address of image resource (need base64 encode)<\/td>true<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/p>\n\n\n\n
Request<\/p>\n\n\n\n

<\/p>\n\n\n\n
{\n    \"profileId\": \"056FEE67-A1E2-412B-866F-78DEA5AF2D22\",\n    \"body\": \"E:\\xlogin\\myscreenshot.png\"\n}\n<\/mark><\/code><\/pre>\n\n\n\n


<\/p>\n\n\n\n
Note:<\/strong><\/p>\n\n\n\n
<\/p>\n\n\n\n
<\/p>\n\n\n\n
1. Enable browser automation settings and save the settings on the XLogin client. For the tutorial, please refer to the\u00a0\"Launch the browser automation port\"<\/a><\/strong>;<\/p>\n\n\n\n

<\/p>\n\n\n\n
2. profileId: Please refer to the\u00a0\"Where can the Profile ID be Found?\"<\/a><\/strong>\u00a0tutorial or use the\u00a0profile\/list interface<\/a><\/strong>\u00a0to get all profileId.<\/p>\n\n\n\n

<\/p>\n\n\n\n
3. Body is the local absolute path where the screenshot is saved and needs to be base64 encoded. <\/p>\n\n\n\n

<\/p>\n\n\n\n
For example, the path to save the image: E:\\xlogin\\myscreenshot.png encoded as RTpceGxvZ2luXG15c2NyZWVuc2hvdC5wbmc=<\/p>\n\n\n\n

<\/p>\n\n\n\n
4. Please do not minimize your browser when using the Screenshot interface.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n

<\/p>\n","protected":false},"featured_media":0,"parent":810,"menu_order":49,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-2600","docs","type-docs","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2600","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/comments?post=2600"}],"version-history":[{"count":5,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2600\/revisions"}],"predecessor-version":[{"id":2750,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2600\/revisions\/2750"}],"up":[{"embeddable":true,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/810"}],"next":[{"title":"API Get ALL Cookie","link":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-get-all-cookie\/","href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2604"}],"prev":[{"title":"API Execute Script","link":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-execute-script\/","href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2597"}],"wp:attachment":[{"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/media?parent=2600"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/doc_tag?post=2600"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}