{"id":2394,"date":"2023-08-04T14:20:48","date_gmt":"2023-08-04T06:20:48","guid":{"rendered":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-interfaces\/"},"modified":"2024-12-04T15:47:02","modified_gmt":"2024-12-04T07:47:02","slug":"api-interfaces","status":"publish","type":"docs","link":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/api-interfaces\/","title":{"rendered":"REST API Interface Examples"},"content":{"rendered":"\n

REST<\/strong> API interface examples:<\/strong><\/p>\n\n\n\n


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

Groups<\/mark><\/strong><\/p>\n\n\n\n


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

Type<\/strong><\/td>Description<\/strong><\/td>API<\/strong><\/td><\/tr>
POST\/GET<\/td>Create a group<\/td>\/tag\/create<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Remove a group<\/td>\/tag\/remove<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Rename a group<\/td>\/tag\/rename<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Get all groups list<\/td>\/tag\/list<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Move the profile to specific group<\/td>\/tag\/profile\/add<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Move the profile from a specific group to the default group<\/td>\/tag\/profile\/remove<\/a><\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n



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

Profiles<\/mark><\/strong><\/p>\n\n\n\n


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

Type<\/strong><\/td>Description<\/strong> <\/td>API<\/strong><\/td><\/tr>
POST<\/td>Randomly create browser profile<\/td>\/profile\/random<\/a><\/strong><\/td><\/tr>
POST<\/td>Create browser profile <\/td>\/profile\/create<\/a><\/strong><\/a><\/td><\/tr>
POST<\/td>Update browser profile settings<\/td>\/profile\/update<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Detail browser profile<\/td>\/profile\/detail<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Sharing browser profile (batch operation)<\/td>\/profile\/share<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Browser profile unshare (batch operation)<\/td>\/profile\/cancelShare<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Transfer browser profile\u2019s ownership (batch operation) <\/td>\/profile\/transferOwnership<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Release the browser profile (batch operation)<\/td>\/profile\/release<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Remove browser profile (batch operation)<\/td>\/profile\/remove<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Get a list of all available browser profiles<\/td>\/profile\/list<\/a><\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n




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

UserAgent<\/mark><\/strong><\/p>\n\n\n\n


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

Type<\/strong><\/td>Description<\/strong><\/td>API<\/strong><\/td><\/tr>
GET\/POST<\/td>Get a random User-Agent<\/td>\/ua\/rand<\/a><\/strong><\/td><\/tr><\/tbody><\/table>

<\/figcaption><\/figure>\n\n\n\n



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

Local REST API<\/mark><\/strong><\/p>\n\n\n\n


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

Type<\/strong><\/td>Description<\/strong><\/td>API<\/strong><\/td><\/tr>
POST\/GET<\/td>Launch the browser profile<\/td>\/profile\/start<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Stop the browser profile<\/td>\/profile\/stop<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Refresh the browser profile<\/td>\/profile\/refresh<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Open the specified page on the current tabs<\/td>\/profile\/openurl<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Open a new TAB<\/td>\/profile\/newtab<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Get webpage source code<\/td>\/profile\/source<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Send the file to the webpage<\/td>\/profile\/sendKeys<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Check the profile is running correctly<\/td>\/profile\/active<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Get a random profile information<\/td>\/profile\/randomProfile<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Delete a profile of local TEMP folder<\/td>\/profile\/delete<\/a><\/strong><\/td><\/tr>
POST<\/td>Create the local profile and launch it<\/td>\/profile\/create_start<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Export the cookies from profile<\/td>\/profile\/cookies\/export\/webext<\/a><\/strong><\/td><\/tr>
POST<\/td>Import cookie to browser profile<\/td>\/profile\/cookies\/import\/webext<\/a><\/strong><\/td><\/tr>
POST<\/td>Execute Script<\/td>\/profile\/ExecuteScript<\/a><\/strong><\/td><\/tr>
POST<\/td>Screen Shot<\/td>\/profile\/ScreenShot<\/a><\/strong><\/td><\/tr>
POST<\/td>Get ALL Cookie<\/td>\/profile\/getCookies<\/a><\/strong><\/td><\/tr>
POST<\/td>Ask if the current page is loaded<\/td>\/profile\/readyState<\/a><\/strong><\/td><\/tr>
POST\/GET<\/td>Switch Frame<\/td>\/profile\/SwitchToFrame<\/a><\/strong><\/td><\/tr>
GET<\/td>Test Proxy<\/td>\/proxy\/test<\/a><\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n



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

Description of Settings in the Profiles<\/mark><\/strong><\/p>\n\n\n\n


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

Name<\/strong><\/td>Specific Description<\/strong><\/td><\/tr>
Create Profile<\/td>createProfileRequest<\/a><\/strong><\/td><\/tr>
deviceOS List<\/td>devicesOS<\/a><\/strong><\/td><\/tr>
acceptLanguage List<\/td>acceptLanguage<\/a><\/strong><\/td><\/tr>
fontList<\/td>fontList<\/a><\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

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





<\/p>\n","protected":false},"featured_media":0,"parent":810,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-2394","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2394","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=2394"}],"version-history":[{"count":30,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2394\/revisions"}],"predecessor-version":[{"id":3490,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/2394\/revisions\/3490"}],"up":[{"embeddable":true,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/810"}],"next":[{"title":"Local API for Routine Automation Operations","link":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/local-api-for-routine-automation-operations\/","href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/502"}],"prev":[{"title":"XLogin REST API","link":"https:\/\/www.xlogin.us\/help\/docs\/api-automation\/xlogin-rest-api\/","href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/docs\/499"}],"wp:attachment":[{"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/media?parent=2394"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.xlogin.us\/help\/wp-json\/wp\/v2\/doc_tag?post=2394"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}