EagletAPI - 在线接口文档

序号	接口服务	接口名称	接口描述
1	App.Address.SearchCaAddress	查询加拿大地址付费	根据关键字查询加拿大地址
2	App.Ai.CheckTitle	检查商品名称-中英双语付费	检查商品名称-中英双语，返回参数说明：产品-product；功能-function；品牌-brand；图案-pattern；颜色-color；用户群体-consumer_group；风格-style
3	App.Ai.TranslateEnToZh	机器翻译-英译中付费	机器翻译-英译中
4	App.Ai.TranslateZhToEn	机器翻译-中译英付费	机器翻译-中译英
5	App.Airfreight.AddAwbNum	提交航空提单号付费	批量提交航空提单号此API每小时内最多调用100次，此API每次调用最多上传100个快递单号。
6	App.Airfreight.CheckAwbNum	检查航空提单号是否已存在	检查航空提单号是否已存在
7	App.Airfreight.GetAirlineByAwb	查询航空公司	根据航空运单号查询航空公司
8	App.Airfreight.GetWebhook	查询回调地址	查询当前应用是否设置了回调地址
9	App.Airfreight.QueryAwbNum	查询已提交的航空提单号	查询当前用户已提交的航空提单号
10	App.Airfreight.SetWebhook	设置回调地址	当前用户已提交航空提单号的轨迹有更新时，系统会调用当前用户设置的Webhook URL，将轨迹数据同步给当前用户。
11	App.Airfreight.TrackAwbNum	实时查询轨迹	查询实时空运提单轨迹信息，目前支持南方航空784 东方航空112 海南航空880 加拿大航空014 国泰航空160 长荣航空695 大韩航空180 近期更新支持下列航空厦门航空731 全日空航空205
12	App.Auth.AppUserLogin	应用会员登录	最严格的授权方式，同时进行应用和会员的验证，应用由服务端传送，会员登录由客户端实现。
13	App.Auth.ApplyToken	申请访问令牌必备	通过应用校验进行授权，根据客户端应用的app_key和app_secret创建新的访问令牌
14	App.Auth.RefreshAccessToken	刷新访问令牌	根据已经取到的access_token，延长有效时间，生成新的访问令牌
15	App.Auth.UserLogin	会员登录	通过会员登录进行授权，根据会员的账号和密码进行会员登录，登录成功后分配新的访问令牌
16	App.BarCode.Gen	条形码生成接口	根据内容，生成条形码，并直接输出图片
17	App.Company.GetCompanyInfoByTitle	企业工商数据精准查询付费	数据来自独家权威渠道，持续更新中，每次更新缓存30天
18	App.Config.GetConfig	获取配置	根据配置名称，获取管理后台配置管理中配置值
19	App.Device.GetDeviceInfo	查询设备信息	根据设备编号查询设备信息
20	App.Device.Submit	提交扫描记录	提交扫描记录
21	App.Express.GetCompanyByNumber	单号查快递公司	根据单号查快递公司
22	App.Express.GetTrackByNumber	单号查快递轨迹付费	根据单号查快递派送轨迹
23	App.File.Upload	文件上传	上传文件到服务器本地，并将上传纪录存在数据库。默认可上传任何类型的文件，可通过修改接口参数配置限制文件类型。
24	App.File.UploadByBase64	base64上传文件	通过Base64编码后，上传图片、Word、Excel和PPT，以及PDF、TXT文本、HTML页面、Zip压缩包等文件。
25	App.Finance.ExchangeRateConversion	汇率转换	比如金额人民币100元，可以转为多少美元（或其他外币）。
26	App.Finance.GetCodeList	支持的外汇币种列表	返回所有支持的外汇列表。
27	App.Finance.GetExchangeRates	中国银行的实时汇率	包括常见国家货币的汇率：菲律宾比索，瑞典克朗，新加坡元，阿联酋迪拉姆，澳大利亚元，巴西里亚尔，加拿大元，瑞士法郎，丹麦克朗，欧元，英镑，港币，印尼卢比，印度卢比，日元，韩国元，澳门元，林吉特，挪威克朗，新西兰元，卢布，泰国铢，新台币，美元，南非兰特，人民币。
28	App.HelloWorld.HiApp	令牌验证接口示例	需要进行access_token令牌验证接口示例，创建应用后通过App.Auth.ApplyToken接口申请令牌后方可访问。熟悉后可删除此示例接口。
29	App.HelloWorld.HiMember	登录检测接口示例	除了令牌，还需要会员登录，此时需要通过App.User.UserLogin接口返回的令牌（含app_key+uid）。熟悉后可删除此示例接口。
30	App.HelloWorld.HiRights	权限判断接口	默认情况下，你的应用没有权限调用些接口，在管理后台添加权限后方可正常调用。熟悉后可删除此示例接口。
31	App.HelloWorld.Say	接口示例	一个开放接口示例，可直接访问，不需要任何验证，因为配置了service_whitelist白名单。熟悉后可删除此示例接口。
32	App.HsCode.CaHsCodePredictEn	根据英文商品描述查询加拿大海关编码	根据英文商品描述查询加拿大海关编码
33	App.IP.GetInfo	获取IP地址归属信息接口	根据IP地址获取归属信息，定位用户所在城市
34	App.Pinyin.Abbr	汉字拼音首字母接口	获取首字符字符串
35	App.Pinyin.Convert	汉字转拼音接口	将一段汉字串内容转成拼音
36	App.Pinyin.Name	姓名转拼音接口	姓名转拼音，姓名的姓的读音有些与普通字不一样，比如 ‘单’ 常见的音为 dan，而作为姓的时候读 shan。
37	App.Pinyin.Sentence	翻译整段汉文为拼音接口	将会保留中文字符：，。！？： “ ” ‘ ’ 并替换为对应的英文符号。
38	App.Printer.AddPrinter	新增云打印机	新增云打印机
39	App.Printer.AddPrinterTask	增加云打印机打印任务	增加云打印机打印任务
40	App.Printer.CallbackTest	回调接口推送执行结果测试	回调接口推送执行结果测试
41	App.Printer.DeletePrinter	删除云打印机	根据打印机ID删除云打印机
42	App.Printer.DeletePrinterTask	删除云打印机打印任务	根据任务ID删除云打印机打印任务
43	App.Printer.DisablePrinter	停用云打印机	根据打印机ID停用云打印机
44	App.Printer.EnablePrinter	启用云打印机	根据打印机ID启用云打印机
45	App.Printer.GetPrinterDetailById	获取云打印机详情	根据打印机ID获取云打印机详情
46	App.Printer.GetPrinterDetailByTitle	获取云打印机详情	根据打印机名称获取云打印机详情
47	App.Printer.GetPrinterList	获取云打印机列表	获取云打印机列表
48	App.Printer.GetPrinterTask	获取云打印机打印任务	获取云打印机打印任务
49	App.Printer.GetPrinterTaskById	查询云打印机打印任务	根据任务ID查询云打印机打印任务
50	App.Printer.GetWhiteList	获取云打印机白名单	获取云打印机白名单
51	App.Printer.ModifyPrinter	修改云打印机	根据打印机ID修改云打印机
52	App.QrCode.Card	生成名片二维码	生成名版二维码，支持名字、手机号、联系电话、邮箱、工作地址、组织等
53	App.QrCode.Logo	生成带logo的二维码	生成带logo的二维码
54	App.QrCode.Mailto	生成发邮件二维码	根据邮箱地址，生成后手机扫码后可直接进入邮件发送界面
55	App.QrCode.PhoneNumber	生成电话号码二维码	根据电话号码生成二维码，生成后手机扫码后可直接进入电话拨打。
56	App.QrCode.Png	根据文本内容，生成二维码	可根据传入的文本内容，生成对应的二维码，还可以调整尺寸大小。可以直接输出png图片，也可以返回base64后的图片数据。
57	App.QrCode.Sms	生成发短信二维码	根据手机号生成二维码，生成后手机扫码后可直接进入短信编辑发送界面
58	App.Redis.DecrBy	Redis自定义自减	根据key自减num，不存在时会自动创建并设置初始值为-num
59	App.Redis.Get	根据key读取缓存	根据key读取缓存
60	App.Redis.IncrBy	Redis自定义自增	根据key自增num，不存时会自动创建并设置初始值为num
61	App.Redis.Set	写入数据	从Redis中写入数据，可以指定失效时间，也可以永远有效。
62	App.Sms.AliyunQuerySendDetails	阿里云查看短信发送记录和发送状态	通过阿里云的QuerySendDetails接口查看短信发送记录和发送状态。使用前请修改./config/app.php配置文件中的aliYun配置。
63	App.Sms.AliyunSendSms	阿里云发送短信接口	通过阿里云的SendSms发送短信。使用前请修改./config/app.php配置文件中的aliYun配置。
64	App.Ups.Ship	Ship接口	用来转发UPS下单接口
65	App.Ups.Test	//请检测函数注释	//请使用@desc 注释
66	App.User.AlterPass	修改当前会员密码	会员登录根据旧密码修改当前会员的新密码，需要会员先登录。
67	App.User.Profile	获取我的资料	会员登录获取当前登录会员自己的个人资料，更为全面的个人资料。
68	App.User.Register	会员注册接口	根据账号和密码进行普通会员注册
69	App.User.UpdateProfile	更新我的会员资料	会员登录更新指定会员账号的资料
70	App.User.UserProfile	获取会员资料	根据账号，获取指定会员的个人资料，可以获取其他会员的个人资料。
71	App.UserWeixin.FastLogin	微信快捷联登	微信快速登录，新客时将直接创建应用会员并进行绑定；已绑定则直接登录。支持微信小程序登录，以及微信公众号登录。

切换到折叠版