这是 Eagle API 官方文档,我们希望透过开放 Eagle API,让每一位用户都有机会可以开发属于自己的插件、扩充功能,满足更多场景的需求,这系列文章我们除了会详细介绍 Eagle API 如何使用外,同时也会提供参考的实际范例,抛砖引玉,希望每位用户都可以透过简单的脚本,开发出更多好玩的扩展。

注意:使用 Eagle API 时,表示你已经同意 Eagle 的用户协议隐私权政策

服务器

Eagle 是本地应用,Eagle API 服务器会在软件打开时启动,因此你必须将 Eagle 软件打开,才能够使用 Eagle API 的所有功能。

格式

目前所有 API 服务器会在 Eagle 软件打开时启动,默认监听端口为 41595 ,即 http://localhost:41595/ ,返回的结果都会是 JSON 格式。

CORS

如果你想要透过「油猴」等脚本扩展在网页中使用 Eagle API,请使用 GM_xmlhttpRequest 方法进行呼叫,即可避免跨域安全限制的问题。

  1. GM_xmlhttpRequest({
  2. url: EAGLE_IMPORT_API_URL,
  3. method: "POST",
  4. data: JSON.stringify({ items: images, folderId: pageInfo.folderId }),
  5. onload: function(response) {}
  6. });

限制

Eagle API 需要搭配 Eagle 1.11 Build21(2020/06/17 发布) 及后续版本才能使用。

API 服务器性能取决于运行 Eagle 软件设备,由于皆是本地连线,因此目前没有任何呼叫次数的限制。大部分添加内容的 API 都有单数/复数两种版本,如果你需要添加大量文件,建议使用复数版本。

提交需求

目前 Eagle API 已经提供大部分创建内容需要的功能,假如你在使用的过程中发现有需求无法被满足,需要更多接口才能支持,欢迎写邮件向我们提交你的需求!

邮箱:services@eagle.cool
标题:Eagle API 功能请求:功能简介
内文:详细描述你正在开发的脚本、扩展,并详细描述为什么你需要这项新功能。