API

1. 简介

基础API接口，支持Local API接口功能，通过程序化方式，读写账号配置信息、启动和关闭浏览器、查询账号列表等基础API功能，支持从Dolphin、 Multilogin、 Gologin迁移环境到AdsPower

API参数示例： https://documenter.getpostman.com/view/45822952/2sB2x5JDXn

API接口文档： https://localapi-doc-zh.adspower.net/

迁移环境：

从Dolphin Anty、Multilogin、 Gologin迁移环境到 AdsPower： https://help.adspower.net/docs/TransferProfiles

2. 如何使用 AdsPower Local API

2.1 获得AdsPower Local API 接口

2.2 打开AdsPower客户端保持登录状态

2.3 软件左侧导航栏-“自动化 -> API”查看API接口成功启动的状态

3. 如何使用 api-key和headless （仅支持付费套餐使用）

3.1 AdsPower支持headless配合api-key启动无界面服务操作Local API

基本信息注意：开始操作前请确保应用版本升级至v3.3.2及以上，内核版本升级至v2.4.2.8及以上，并具有基础API的权限。

• headless：启动无界面服务的参数
• api-key：无界面服务中操作Local API接口的身份凭证，一个账号对应一个api-key，支持一个账号在多设备同时操作Local API接口

3.2 账号管理→设置处获取api-key

3.3 使用命令行命令配合api-key启动无界面服务

3.3.1 请确保您在AdsPower主目录中（AdsPower/AdsPower Global）打开了您的CMD或Terminal

3.3.2 命令行启动

AdsPower Global：
Windows设备下： "AdsPower Global.exe" --headless=true --api-key=XXXX --api-port=50325
MacOS设备下："/Applications/AdsPower Global.app/Contents/MacOS/AdsPower Global" --args --headless=true --api-key=XXXX --api-port=50325
Linux设备下：adspower_global --headless=true --api-key=XXX --api-port=50325

启动成功后，在命令行工具处可以看到启动成功后返回的Local API地址

FAQ

Q： 可以在同一个设备同时启动有界面和无界面服务吗？

A：不能

Q：如果更换了api-key，用旧值启动的服务调用的api接口还能继续用吗？

A：不能。会返回api-key失效的信息，一个账号仅能对应一个api-key，所以谨慎操作重置，重置后旧值失效，请安全的保存该值

Q：如何重置api-key？

A：进入账号管理，点击重置api-key，重置后请注意保存

Q：如果更换了api-key，是否能对已启动的服务进行api-key的更新呢？

A：不能。需先关闭服务，重新用新的api-key启动服务

Q：如何关闭服务？

A：可通过ctrl+c(CMD下)或关闭命令行窗口将服务关闭

Q：使用有界面服务和无界面服务启动Local API服务有何区别呢？

A：1. 有界面服务会被限制同个账号只能在一个设备登录
2. api-key则不限制同个账号同时登录多个设备的场景，如果有一个账号想要在多个机器上跑自动化的需求，则可以使用headless配合api-key使用Local API接口