服务器 API

所有 API 请求均为 REST 式样 URL 标准 HTTP 请求。 回应是 JSON 或图像(在提取结果时)。

身份验证

API 使用标准的 HTTP 基本存取身份验证( 请求header 中加入token ) 所有 API 请求将需要包括您的 token 凭据,token可以根据需要进行轮换,变换后旧的token会马上失效

示例中的token是演示值,其状态会不定时变换,不要用在生产活动中

您可以随时在您的个人中心上找到自己的 API 凭证和使用信息。

后端与前端

接口不限制你在后端和前端使用,为了安全起见最佳是在后端调用我们的接口

速率及特效限制

在正常使用过程中,由于该服务一般可轻松应对使用的起伏,您不大可能会遇到任何速率限制。

请求过大可能出现返回结果慢的情况,这个无需担心,我们的服务器采用消息队列模式,会按照队列以此进行生产

psd 生成图片和生成文件的大小(像素值),分辨率(现阶段分辨率最高支持100分辨率), 智能图层的大小和带替换图层的数量都有密切的关系,我们会提供一个【示例PSD】,您可以以此作为制作范版 从而达到生成图片的最佳效果,

我们不是无限的还原ps的全部,请根据我们的 【示例PSD】 进行制作,此包含的全部功能都能完美实现, 如有其他的ps功能需求,可以联系我们,我们进行专门的评估开发

JSON 对象错误

我们使用传统的 HTTP 状态,表示 API 请求成功或失败,并在返回的 JSON 对象错误中包括重要的错误信息。

我们努力始终为任何有问题的请求返回 JSON 对象错误。 但是,从理论上来说,总是可能出现内部服务器故障,从而导致非 JSON 错误回应。

属性

status 回应的 HTTP 状态在此重复,以帮助调试。
code FOXPSD 内部错误代码。
msg 人类可读错误消息,旨在帮助调试。

如果您的请求的 HTTP 状态是 200,则不会返回 JSON 对象错误,您可以安全地假设请求总体而言已取得成功。

一些 HTTP 客户端库为 400-599 范围内的 HTTP 状态引发异常。 您将需要捕获这些异常,并适当处理。

HTTP Status 表示
200-299

成功

400-499

请求中提供的信息存在问题(例如,缺少一个参数)。 请查看错误消息,了解如何纠错。

500-599

出现 FOXPSD 内部错误。 请稍候,然后再重新尝试,如果问题依然存在,请及时联系我们。

FOXPSD 内部code 表示的含义

FOXPSD code 表示
10000

成功

10001

失败,可能是参数验证错误,权限错误等等,请开发者自行检查

10002

token 失效,用于重新登录逻辑

错误回应示例

  1. {
  2. code:10001, //状态码
  3. msg:'权限不足', //提示信息
  4. data:null //可能包含的具体内容
  5. }
json

正确回应示例

  1. {
  2. "code": 10000,
  3. "data": {
  4. "sku": "1637826540047353433"
  5. },
  6. "msg": "请求成功"
  7. }
json

API: 生成浏览器token POST /api/jwt/business/token

生成浏览器token,可生成多个

参数

time
数字
必传
设置token 有效期,单位为秒

结果

code
数字
取值范围为 10000 :操作成功;10001 :操作失败
msg
字符串
信息提示
data.token
字符串

浏览器token

请求演示

  1. //下面是以jquery 的ajax方法进行演示,服务端请用相关的语言发送http请求即可
  2. $.ajax({
  3. type:'POST',
  4. url:'https://foxpsd.com/api/jwt/business/token',
  5. data:JSON.stringify({
  6. time:86400,
  7. }),
  8. headers:{
  9. 'Content-Type': 'application/json',
  10. // 填写你的token 进行身份识别
  11. 'Authorization':'Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  12. },
  13. success(res){
  14. //操作成功
  15. if (res.code == '10000') {
  16. console.log(res)
  17. }else{
  18. console.log(res)
  19. }
  20. },
  21. error(err){
  22. console.log(err)
  23. }
  24. })
js
返回结果
  1. {
  2. "code": 10000,
  3. "data": {
  4. "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImFwcGlkIjoiMTYzNzIwMDMwMDU3MCIsImlkIjoxfSwiZXhwIjoxNjU1NTQ3NzY2LCJpYXQiOjE2NTU1NDQxNjZ9.JtybSLwAAihE0pld25tWTQautdAqWkClBzoCdFdYIAw"
  5. },
  6. "msg": "请求成功"
  7. }
json

API: PSD模板上传 POST https://foxpsd.com/api/psd/save

您使用标准 HTTP POST 文件上载。也可以通过个人中心的psd管理进行手动上传

参数

title
字符串
必传
psd 的标题
url
字符串
必传
psd 的http 的下载链接,必须是有效文件
type
数字
非必传

type 取值范围为 1,5,9 作用是方便进行psd的筛选操作,对生成图片相关的接口没有影响

1 最大500像素 实时预览
5 最大1600像素 效果图
9 最大10000像素 生产图

结果

code
数字
取值范围为 10000 :操作成功;10001 :操作失败
msg
字符串
信息提示
data.sku
字符串

psd 的唯一标识,需要存储到自己的服务器,用于后面的操作

请求演示

  1. //下面是以jquery 的ajax方法进行演示,服务端请用相关的语言发送http请求即可
  2. $.ajax({
  3. type:'POST',
  4. url:'https://foxpsd.com/api/psd/save',
  5. data:JSON.stringify({
  6. title:"TEST1600",
  7. url:"https://foxpsd.com/muban.psd",
  8. type:5//取值范围 非必填 1 500 5 1600 9 10000
  9. }),
  10. headers:{
  11. 'Content-Type': 'application/json',
  12. // 填写你的token 进行身份识别
  13. 'Authorization':'Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  14. },
  15. success(res){
  16. //操作成功
  17. if (res.code == '10000') {
  18. console.log(res)
  19. }else{
  20. console.log(res)
  21. }
  22. },
  23. error(err){
  24. console.log(err)
  25. }
  26. })
js
返回结果
  1. {
  2. "code": 10000,
  3. "data": {
  4. "sku": "1637828090327078525"
  5. },
  6. "msg": "请求成功"
  7. }
json

API: PSD 获取详情GET https://foxpsd.com/api/psd/item

此api是根据sku获取某个特定psd的详情信息

参数

sku
字符串
必传
psd 模板的sku值

结果

code
数字
取值范围为 10000 :操作成功;10001 :操作失败
msg
字符串
信息提示
data.sku
字符串

psd 的唯一标识

data.title
字符串

标题

data.url
字符串

传给foxpsd 的下载链接

data.type
数字

选的类型 取值范围为 1,5,9

data.width
数字

psd的宽度

data.height
数字

psd的高度

data.size
数字

psd的尺寸 单位byte

data.number
数字

psd的使用次数

data.status
数字

psd 状态

0 禁用
1 正常
2 下载中
3 下载失败
data.last_use_date
字符串

最后使用时间

data.create_date
字符串

创建时间

data.update_date
字符串

更新时间

请求演示

  1. //下面是以jquery 的ajax方法进行演示,服务端请用相关的语言发送http请求即可
  2. $.ajax({
  3. type:'GET',
  4. url:'https://foxpsd.com/api/psd/item?sku=1637737947373803488',
  5. headers:{
  6. // 填写你的token 进行身份识别
  7. 'Authorization':'Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  8. },
  9. success(res){
  10. //操作成功
  11. if (res.code == '10000') {
  12. console.log(res);
  13. }else{
  14. console.log(res)
  15. }
  16. },
  17. error(err){
  18. console.log(err)
  19. }
  20. })
js
返回结果
  1. {
  2. "code": 10000,
  3. "data": {
  4. "sku": "1637737947373803488",
  5. "title": "b1-s",
  6. "url": "/1637200300570/psd/20211124/1637737947373803488.psd",
  7. "type": 1,
  8. "width": 500,
  9. "height": 500,
  10. "size": 2068960,
  11. "number": 0,
  12. "business_id": 1,
  13. "status": 1,
  14. "last_use_date": "2021-11-24T09:07:20.000Z",
  15. "create_date": "2021-11-24T09:07:20.000Z",
  16. "update_date": "2021-11-24T09:07:20.000Z"
  17. },
  18. "msg": "请求成功"
  19. }
json

API: PSD 模板列表POST https://foxpsd.com/api/psd/index

此api是获取全部上传的psd 模板列表,支持分页及分页限制获取

参数

page
数字
非必传
分页数 默认值为 1
rows
数字
非必传
分页限制条数 默认值:20条
type
数字
非必传

type 取值范围为 1,5,9 作用是方便进行psd的筛选操作,对生成图片相关的接口没有影响

1 最大500像素 实时预览
5 最大1600像素 效果图
9 最大10000像素 生产图
content
字符串
非必传
搜索psd列表的 sku或者title

结果

code
数字
取值范围为 10000 :操作成功;10001 :操作失败
msg
字符串
信息提示
data.list
字符串

psd list,字段详情请查看详情接口的介绍

data.totalPage
数字

总页数

data.totalRow
数字

总条数

data.curPage
数字

当前页数

请求演示

  1. //下面是以jquery 的ajax方法进行演示,服务端请用相关的语言发送http请求即可
  2. $.ajax({
  3. type:'POST',
  4. url:'https://foxpsd.com/api/psd/index',
  5. data:JSON.stringify({
  6. page:1,
  7. rows:20,
  8. content:"muban",
  9. type:1//取值范围 非必填 1 500 5 1600 9 10000
  10. }),
  11. headers:{
  12. 'Content-Type': 'application/json',
  13. // 填写你的token 进行身份识别
  14. 'Authorization':'Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  15. },
  16. success(res){
  17. //操作成功
  18. if (res.code == '10000') {
  19. console.log(res);
  20. }else{
  21. console.log(res)
  22. }
  23. },
  24. error(err){
  25. console.log(err)
  26. }
  27. })
js
返回结果
  1. {
  2. "code": 10000,
  3. "data": {
  4. "list": [
  5. {
  6. "sku": "1637737947373803488",
  7. "title": "b1-s",
  8. "url": "/1637200300570/psd/20211124/1637737947373803488.psd",
  9. "type": 1,
  10. "width": 500,
  11. "height": 500,
  12. "size": 2068960,
  13. "number": 0,
  14. "business_id": 1,
  15. "status": 1,
  16. "last_use_date": "2021-11-24T09:07:20.000Z",
  17. "create_date": "2021-11-24T09:07:20.000Z",
  18. "update_date": "2021-11-24T09:07:20.000Z"
  19. }
  20. ],
  21. "totalPage": 1,
  22. "totalRow": 2,
  23. "curPage": 1
  24. },
  25. "msg": "请求成功"
  26. }
json

API: PSD 删除POST https://foxpsd.com/api/psd/delete

此api是根据sku删除psd

参数

sku
字符串
必传
psd 模板的sku值

结果

code
数字
取值范围为 10000 :操作成功;10001 :操作失败
msg
字符串
信息提示
data.sku
字符串

psd 的唯一标识

请求演示

  1. $.ajax({
  2. type:'POST',
  3. url:'https://foxpsd.com/api/psd/delete',
  4. data:JSON.stringify({
  5. sku:"1638588366891564577"
  6. }),
  7. headers:{
  8. 'Content-Type': 'application/json',
  9. // 填写你的token 进行身份识别(下面为演示token,请勿用于生产环境)
  10. 'Authorization':'Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  11. },
  12. success(res){
  13. //操作成功
  14. if (res.code == '10000') {
  15. console.log(res)
  16. }else{
  17. console.log(res)
  18. }
  19. },
  20. error(err){
  21. console.log(err)
  22. }
  23. })
js
返回结果
  1. {
  2. "code": 10000,
  3. "data": {
  4. "sku":"1638588366891564577"
  5. },
  6. "msg": "成功"
  7. }
json

API: 图片 生成图片POST https://foxpsd.com/api/shengchengtu/save/:订阅sku

此接口用于生成图片,订阅sku,请在 个人中心 / API计数 中查看

参数

psd_sku
字符串
必传
psd 模板的sku值,选择的psd需要满足订阅产品的最大宽度要求
data
数组
必传
name 图层名称,名称必须英文字母或数字,必须以字母开头,传入中文则无法识别
content 有效的图片链接,格式为jpg,jpeg,png
callback
字符串
非必传
开发者自己的服务器回调地址,生成图片后FOXPSD 会根据这个地址发送一条GET请求,并将生成的结果会以参数'&'拼接的方式返回
包含的参数有:
oss 生成的图片路径,图片只在我们服务器中保存七天的时间,请及时存储
sku 图片 的唯一标识sku
msg 信息提示
code 状态码 10000 操作成功 10001 操作失败,操作失败oss 不存在

结果

code
数字
取值范围为 10000 :操作成功;10001 :操作失败
msg
字符串
信息提示
data.sku
字符串

图片 的唯一标识,需要自己单独存储,后面可用于查询结果详情

data.oss
字符串 可能存在

如果订阅的是 500像素-实时预览产品,还会直接返回此结果,可用于展示

请求演示

  1. $.ajax({
  2. type:'POST',
  3. url:'https://foxpsd.com/api/shengchengtu/save/163765136915264690',
  4. data:JSON.stringify({
  5. "psd_sku":"1637737947373803488",
  6. "data":[
  7. {
  8. "name":"sucai",
  9. "content":"https://yourServer.com/1628674835625.jpg"
  10. },
  11. {
  12. "name":"sucai2",
  13. "content":"https://yourServer.com/1628671976551.jpg"
  14. }
  15. ],
  16. "callback":"https://yourServer.com/test"
  17. }),
  18. headers:{
  19. 'Content-Type': 'application/json',
  20. // 填写你的token 进行身份识别(下面为演示token,请勿用于生产环境)
  21. 'Authorization':'Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  22. },
  23. success(res){
  24. //操作成功
  25. if (res.code == '10000') {
  26. console.log(res)
  27. }else{
  28. console.log(res)
  29. }
  30. },
  31. error(err){
  32. console.log(err)
  33. }
  34. })
js
返回结果
  1. {
  2. "code": 10000,
  3. "data": {
  4. "success": 1,
  5. "msg": "操作成功",
  6. "sku": "1637896425191216816",
  7. //只有支持实时预览的服务才有下面返回值
  8. "oss": "http://xxxxxxx.com/1637200300570/shengchengtu/20211126/163789642619938254.jpg",
  9. "fileName": "163789642619938254.jpg",
  10. "relative": "/163789642619938254.jpg",
  11. },
  12. "msg": "请求成功"
  13. }
json

API: 图片 获取图片详情GET https://foxpsd.com/api/shengchengtu/item

此api是根据sku获取某个特定图片的详情信息

参数

sku
字符串
必传
图片的sku值

结果

code
数字
取值范围为 10000 :操作成功;10001 :操作失败
msg
字符串
信息提示
data.sku
字符串

图片 的唯一标识

data.psd_sku
字符串

psd 的唯一标识

data.business_goods_type_sku
字符串

订阅产品 的唯一标识

data.size
数字

生成的图片大小 单位byte

data.posts
字符串

请求体

data.callback
字符串

自定义的回调地址

data.oss
字符串

生成的图片链接

data.results
字符串

结果的原始集合,code为10001时,包含具体的错误信息

data.status
数字

图片 状态

0 生成失败
1 正常
9 待生成
data.shengchengshijian_date
字符串

生成时间

data.create_date
字符串

创建时间

请求演示

  1. //下面是以jquery 的ajax方法进行演示,服务端请用相关的语言发送http请求即可
  2. $.ajax({
  3. type:'GET',
  4. url:'https://foxpsd.com/api/shengchengtu/item?sku=1637896425191216816',
  5. headers:{
  6. // 填写你的token 进行身份识别
  7. 'Authorization':'Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  8. },
  9. success(res){
  10. //操作成功
  11. if (res.code == '10000') {
  12. console.log(res);
  13. }else{
  14. console.log(res)
  15. }
  16. },
  17. error(err){
  18. console.log(err)
  19. }
  20. })
js
返回结果
  1. {
  2. "code": 10000,
  3. "data": {
  4. "sku": "1637896425191216816",
  5. "psd_sku": "1637737947373803488",
  6. "business_goods_type_sku": "163765136915264690",
  7. "business_id": 1,
  8. "size": 151302,
  9. "posts": "[{\"name\":\"sucai\",\"content\":\"https://printbelle.xiaodaofuli.com/1628674835625.jpg\"},{\"name\":\"sucai2\",\"content\":\"https://printbelle.xiaodaofuli.com/1628671976551.jpg\"}]",
  10. "callback": null,
  11. "oss": "http://127.0.0.1:7002/1637200300570/shengchengtu/20211126/163789642619938254.jpg",
  12. "results": "{\"sku\":\"1637896425191216816\",\"typeSku\":\"163765136915264690\",\"businessId\":\"1\",\"psdSku\":\"1637737947373803488\",\"downUrl\":\"http://127.0.0.1:7002/1637200300570/shengchengtu/20211126/163789642619938254.jpg\",\"fileName\":\"163789642619938254.jpg\",\"relative\":\"/163789642619938254.jpg\",\"success\":\"1\",\"msg\":\"操作成功\"}",
  13. "status": 1,
  14. "shengchengshijian_date": "2021-11-26T03:13:46.000Z",
  15. "create_date": "2021-11-26T03:13:45.000Z"
  16. },
  17. "msg": "请求成功"
  18. }
json

API: 图片列表POST https://foxpsd.com/api/shengchengtu/index

此api是获取全部图片列表,支持分页及分页限制获取

参数

page
数字
非必传
分页数 默认值为 1
rows
数字
非必传
分页限制条数 默认值:20条
content
字符串
非必传
搜索图片列表的 sku || psd 模板的sku || 产品的sku

结果

code
数字
取值范围为 10000 :操作成功;10001 :操作失败
msg
字符串
信息提示
data.list
字符串

图片列表

data.totalPage
数字

总页数

data.totalRow
数字

总条数

data.curPage
数字

当前页数

请求演示

  1. //下面是以jquery 的ajax方法进行演示,服务端请用相关的语言发送http请求即可
  2. $.ajax({
  3. type:'POST',
  4. url:'https://foxpsd.com/api/shengchengtu/index,
  5. data:JSON.stringify({
  6. page:1,
  7. rows:20,
  8. //图片sku || psd_sku || 订阅 sku
  9. content:"xxxxxxxxxx",
  10. }),
  11. headers:{
  12. 'Content-Type': 'application/json',
  13. // 填写你的token 进行身份识别(下面为演示token,请勿用于生产环境)
  14. 'Authorization':'Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  15. },
  16. success(res){
  17. //操作成功
  18. if (res.code == '10000') {
  19. console.log(res)
  20. }else{
  21. console.log(res)
  22. }
  23. },
  24. error(err){
  25. console.log(err)
  26. }
  27. })
js
返回结果
  1. {
  2. "code": 10000,
  3. "data": {
  4. "list": [
  5. {
  6. "sku": "1637745807201117099",
  7. "psd_sku": "1637737947373803488",
  8. "business_goods_type_sku": "163765136915264690",
  9. "business_id": 1,
  10. "size": 151302,
  11. "posts": "[{\"name\":\"sucai\",\"content\":\"https://printbelle.xiaodaofuli.com/1628674835625.jpg\"},{\"name\":\"sucai2\",\"content\":\"https://printbelle.xiaodaofuli.com/1628671976551.jpg\"}]",
  12. "callback": null,
  13. "oss": "http://127.0.0.1:7002/1637200300570/shengchengtu/20211124/1637745808349120480.jpg",
  14. "results": "{\"sku\":\"1637745807201117099\",\"typeSku\":\"163765136915264690\",\"businessId\":\"1\",\"psdSku\":\"1637737947373803488\",\"downUrl\":\"http://127.0.0.1:7002/1637200300570/shengchengtu/20211124/1637745808349120480.jpg\",\"fileName\":\"1637745808349120480.jpg\",\"relative\":\"/1637745808349120480.jpg\",\"success\":\"1\",\"msg\":\"操作成功\"}",
  15. "status": 1,
  16. "shengchengshijian_date": "2021-11-24T09:23:28.000Z",
  17. "create_date": "2021-11-24T09:23:27.000Z"
  18. }
  19. ],
  20. "totalPage": 1,
  21. "totalRow": 1,
  22. "curPage": 1
  23. },
  24. "msg": "请求成功"
  25. }
json