@a335031 2017-10-27T08:08:17.000000Z 字数 33581 阅读 2156

API文档

V.Fine

撤回作品审核

作品增加两个状态
- UNSUBMIT # 待提交
- DELETE # 伪删除

音乐人撤回作品：
PATCH /works/<uuid>/

Request body:

{
    "status": "UNSUBMIT"
}

音乐人上下架作品：
PATCH /works/<uuid>/

Request body:

{
    "status": "ONLINE",    # or OFFLINE
}

音乐人删除作品：
DELETE /works/<uuid>/

OPS普通拒绝：
PATCH /works/<uuid>/

Request body:

{
    "status": "UNSUBMIT"
}

音乐人上传音乐

POST /works/

原有内容不变，添加 owner 字段，所有音乐获取相关的接口的 response 都需要添加这一字段

owner:
  name: 姓名
  phone: 手机
  address: 通讯地址

音乐人更新个人作品

PUT /works/<uuid>/

更改音乐的元数据并将音乐状态变为待审核

OPS 编辑音乐

PATCH /works/<uuid>/

OPS 音乐审核

PATCH /works/<uuid>/

WAITING 待审核
ONLINE 通过
FAIL 拒绝
OFFLINE 下架

{
  "status": "FAIL",
  "remark": "low"
}

获取音乐人自己的作品

GET /mps/works/

返回所有状态的作品

获取指定音乐人的作品

GET /mps/<uuid>/works/

仅返回在线的作品

提现记录

GET /admin/takeout/

增加个人所得税

tax
status:
- REQUESTING 申请中
- WAITING 待转账
- SUCCESS 提现成功
- FAIL 申请失败
- CANCELED 已取消

提现审核

PUT /admin/takeout/<uuid>/

status:
- REQUESTING 申请中
- WAITING 待转账
- SUCCESS 提现成功
- FAIL 申请失败
- CANCEL 已取消

{
  "status": "FAIL",
  "remark": "low"
}

API文档
- 撤回作品审核
API详细文档

API详细文档

说明:
<1> api版本为 /v1/
<2> 如果api返回错误信息，格式统一如下:

{
    "message": "Wrong..."
}

只有error message(不需要code来细分错误)

{
  "message": "wrong...",
  "code": "a_b_c"
}

有code，用于错误细分，具体如下：

phone_unique, email_unique: 该手机号或邮箱已存在
invalid_value: 号码不规范
time_limit_exceeded: 验证码已经超时，请重新发送
identify failed: 验证失败
action_already_done: 当前操作已完成
time_limit_exceeded: 输入验证码超过时间限制
require_captcha: 登录失败次数过多，需要验证码
email_not_activated: 邮箱未激活
unsupported: 当前对象不支持该操作
upstream_error: 上游服务错误，包括发送频率过高，发送次数达到上限
too_many_requests: 调用频率过高，例如手机验证码发送频率
unsent_code: 请先发送验证码
wrong_code: 错误的验证码
wrong_auth: 请先验证身份
wrong_password: 密码错误

{
    "detail": "Not found."
}

404时返回的，无需处理response信息

<3> 有的API开始定的不合理，会尽量都在下面补充上修正计划，前端可以先以文档中所说做好兼容

分页策略：

所有分页的接口都可设置参数page_size，用于指定每页的个数。例如：

/accounts/?page=4&page_size=6

1. auth

注册

POST /users/

Request:

{
    "phone": "+8617778059999",
    "password": "123223",
}

phone/email 用户注册时填写的手机或者邮箱
password 密码明文

Response 200:

{
  "email": "yanhangyhy@icloud.com",
  "email_activated": false,
  "phone": "",
  "type": "Visitor",
  "uuid": "D81E059E-30ED-471A-A836-42C9E963323B"
}

Response 400: 传入参数不规范

missing_body_field
invalid_value 传入的邮箱或者手机号为空,邮箱格式不合法等
db_integrity_error 创建用户时失败，重复的手机号/邮箱注册等(最好在之前已检查过)

Response 401：验证失败

检查用户是否存在

GET /users/check

Query Params:

email / phone

返回200, Response如下:

{
  'result': True/False
}

分别表示用户存在和不存在的状况

登出

PUT /users/logout

Response 204: 登出成功

Response 401: 未认证

发送验证码

PUT /auth/send/

{
    "phone": "+8618566669999",
    "email": ""
}

Response 204:

Response 400

invalid_value: 号码不规范
missing_body_field 缺少字段
too_many_requests 发送频率太高
upstream_error 调用第三方服务失败

检查验证码

PUT /auth/verify/

Request:

{
    "phone": "+86123456788901",
    "code": "1234"
}

code 字符串类型

Response 204

Response 400:

time_limit_exceeded 超过时间限制(30分钟)
missing_body_field 缺少字段
phone_verify_failed 验证失败

2. 用户个人管理

（login required)

检查密码是否正确

GET /users/check-password?password=<xxxx>

Response:

204 正确
400
precondition_failed 密码不正确
missing_query_params

更改密码

PUT /users/password

{
  "old_password":"123223",
  "new_password":"22333"
}

发送的密码均为明文

Response

204 更改成功，应该跳转页面，让用户重新登录
400
- precondition_failed 前置条件不满足，即旧密码输入的不对
- missing_body_field

更换手机

PUT /users/change-phone

Request Body:

{
  "phone": "+8612312341234",
  "password": "123223"
}

phone : 新手机号

Response:

204 更换成功
400
- missing_body_field
- precondition_failed 密码错误
- phone_unique 该手机号已被绑定到其它账号

更换邮箱

PUT /users/change-email

Request Body:

{
  "email": "new_email@163.com",
  "password": "123223"
}

Response:

204
400
- missing_body_field
- precondition_failed 密码错误
- email_unique 该邮箱已被绑定到其它账号

更新用户profile

PUT /v1/users/profile

Request:

{
  'name': '崔老师',
  'location': {
  },
  'avatar': '/path/to/avatar.jpg'
}

暂时支持这三个字段，可只传部分字段。其中 location为json串，后端不做验证，由前端自己决定格式。

Response 204

Response 404 用户不存在

Response 401

获取用户profile

GET /users/profile

Response 200:

{
  'name': 'a',
  'avatar': '/path',
  'location': {},
  "uuid": "BBC6E384-29B0-42E0-B37F-2D57B6837392",
  "email": "a@163.com",
  "phone": "+86123456779",
  "type": "MUSICIAN",
  "musician": {
    "type": "SINGER",
    "today_profit": 100,
    "level": "STAR"
  }
}

musician : 当type为MUSICIAN 时才会有此字段

更新用户关系(关注/取关)

PUT /users/update-relation

{
  'type': 'FOLLOW',
  'uuid': '7ECE1B98-4A3B-482C-8604-4D8E45A75AD9'
}

type : 动作类型: FOLLOW/UN-FOLLOW
uuid: 目标用户uuid

Response:

204
400
- missing_body_field
- invalid_value type取值不对

收藏或者取消收藏work

PUT /users/collect-work/

Request body:

{
    'uuid': str(works.uuid),
    'type': 'LIKE'
}

uuid, 歌曲works的uuid
type
- LIKE
- UN-LIKE

Response 204 收藏或取消收藏成功

获取用户收藏歌曲的列表

GET /users/<uuid>/collection-works/

Response 200

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "uuid": "0c527003-3372-47ac-a2db-0f07381dae9f",
            "producer": "2197a343-8209-4e00-b7ba-fafe25d68169",
            "length": 0,
            "essence_start": 0,
            "essence_end": 0,
            "name": "x1",
            "path": "xx.path",
            "desc": "",
            "avatar": "",
            "tags": [],
            "categories": [],
            "size": 0,
            "status": "ONLINE",
            "created_at": "2017-02-06 03:02",
            "type": "PERSONAL",
            "can_sell": true
        }
    ]
}

获取粉丝列表

只对音乐人有效，并且返回的列表里只包含音乐人，且以作品被收藏数量排名

GET /users/followers

Response 200

{
   "data":[
      {
         "location":{
         },
         "musician":{
            "type":"SINGER"
         },
         "works_likes":5,
         "avatar":"/test/pics/musician_profile.png",
         "name":"ZhangSan"
      },
      {
         "location":{
         },
         "musician":{
            "type":"SINGER"
         },
         "works_likes":4,
         "avatar":"/test/pics/musician_profile.png",
         "name":"ZhangSan"
      },
      {
         "location":{
         },
         "musician":{
            "type":"SINGER"
         },
         "works_likes":2,
         "avatar":"/test/pics/musician_profile.png",
         "name":"ZhangSan"
      }
   ]
}

获取关注列表

目前只对音乐人有效，只显示其关注的音乐人，按作品被收藏数量排序

GET /users/following

Response 200:

{
   "data":[
      {
         "location":{
         },
         "musician":{
            "type":"SINGER"
         },
         "works_likes":5,
         "avatar":"/test/pics/musician_profile.png",
         "name":"ZhangSan"
      }
   ]
}

获取个人创建的项目包列表

GET /users/projects/

Repsonse 200:

{
    "count": 14,
    "next": "http://host/v1/users/projects?page=2",
    "previous": null,
    "results": [
        {
            "category": "TV",
            "uuid": "2f21f671-a9f2-4e3a-a186-6becf83e60d2",
            "level": "NORMAL",
            "created_at": "2016-10-09T05:59:55.717Z",
            "desc": "......",
            "type": "CASE",
            "name": "可口可乐，
            "cover": "/path/to/cover",
            "status": "APPLYING/ACCEPTED/REJECTED/STARTED/FISHISED"
        },
        ...
    ]
}

删除个人创建的项目包（只删除被后台拒绝的项目包）

DELETE /projects/<uuid>/

Response 204: 删除成功

Response 400: This project does not belong you.

通过手机或邮箱来修改密码

发送验证码
检查验证码
调用本接口

PUT /users/forget-password/

Request Body:

{
  "phone": "+8617778051213",
  "email": "",
  "password": "123"
}

Response 204 修改成功

Response 400：

{
  "message": "Verify your account first"
  "code": "precondition_failed"
}

3. 用户信息

获取其他用户profile

GET /users/<uuid>/

Response 404: 用户不存在

Response 200:

{
    "uuid": "48b475fb-a796-41bc-8fe4-d8b7497aee4d",
    "level": "STAR",
    "name": "eigenTunes亦听",
    "location": {
        "city": "广东省",
        "country": "中国"
    },
    "is_musician": true,
    "desc": "这是一段描述",
    "type": "PRODUCER",
    "categories": [
        {
            "id": 222,
            "name": "交响",
            "real": false,
            "parent": 219
        },
        ...
    ],
    "avatar": "default/nbJvfOaMreqqNmVNMESExxNMU0iBoLkDjY4sY6OTX47bJRuEgj.png"
}

music_producer 当用户是音乐人时有此字段，否则没有
- is_following 当前用户(已登录) 是否已关注目标用户，未登录时无此字段
- works_collected_count 音乐人作品被收藏统计
- level 音乐人等级，取值范围: STAR/NORMAL

4. 文件存储

此目录下api在另一个项目 neptunus中

获取存储服务相关信息

GET /storage/upload-info

Query Params:

file_type 支持default/pics/songs 默认为default

Response 200:

{
  "config": {
    "accessid": "99roeiWDhKO0McAY",
    "callback": "eyJjYWxsYmFja0JvZHlUeXBlIjogImFwcGxpY2F0aW9uL2pzb24iLCAiY2FsbGJhY2tCb2R5IjogIntcIm1pbWVUeXBlXCI6JHttaW1lVHlwZX0sXCJzaXplXCI6JHtzaXplfSxcImZpbGVuYW1lXCI6JHtvYmplY3R9fSIsICJjYWxsYmFja1VybCI6ICJodHRwOi8vNTIuMTc1LjI2LjE3Ojk1MzAvdjEvY2FsbGJhY2sifQ==",
    "host": "http://vfine.oss-cn-beijing.aliyuncs.com",
    "expire": 1472103817,
    "signature": "s6m44WCovRKDZzpUMebuL2i82Es=",
    "policy": "eyJjb25kaXRpb25zIjogW1sic3RhcnRzLXdpdGgiLCAiJGtleSIsICJkZWZhdWx0LyJdXSwgImV4cGlyYXRpb24iOiAiMjAxNi0wOC0yNVQwNTo0MzozN1oifQ==",
    "dir": "default/"
  },
  "storage": "oss"
}

response处理及后续操作请参考 neptunus/tests/index.html文件.

CALLBACK 返回的Response为:

{
  "mimeType": "image/png",
  "filename": "default/TCWt7CZ8fD.png",
  "size": 415533
}

filename文件路径最终加上上面的host地址即构成了文件的绝对路径

5. 组

(login_required)

创建组

POST /groups/

Request Body:

{
  "name": "group1"
}

Response 200:

{
  "name": "group1"
}

将其他用户添加进组

PUT /groups/add-user

Request Body:

{
  "user_id": "BBC6E384-29B0-42E0-B37F-2D57B6837392",
  "group_name": "group1"
}

Response:

204 成功
403 没有权限
404 用户或组不存在

6. 音乐人相关

(login required)

音乐人认证

PUT /mps/identification

Rquest body:

{
  "avatar": "/path",
  "name": "lee",
  "occupations": ["singer"],
  "id": "13010419xxxxx1234",
  "id_card_": "/path",
  "id_card_": "/path",
  "music": "music path"
}

Response:

204
400
- missing_body_field
- invalid_value
- action_already_done 已经申请过了

获取认证状态

GET /mps/identification

注意只有当用户类型为游客时才需要调用此API

Response 200:

{
  "is_done": null or true/false
}

null 未提交或已拒绝
true 已通过
false 审核中

筛选定制音乐人

(no login required)

GET /mps/

Query params:

level: STAR
purpose: 项目类型
country: China or Overseas

Response 200:

{
    "results": [
        {
            "uuid": "929898b3-b715-4e7d-ba9e-cf31edfa8213",
            "name": "李天衣",
            "avatar": "default/sS6MITzuYrCUrQKVzhAUp0de0GOM4aCKeo4K4xqqZfqXdYTAOu.png",
            "location": {
                "city": "北京市",
                "country": "中国"
            },
            "categories": [
                {
                    "id": 222,
                    "name": "交响",
                    "real": false,
                    "parent": 219
                },
                ...
            ],
            "theme_song": null,
            "projects": [
                {
                    "uuid": "721fc2ec-5fc1-46a9-a316-1306404c6469",
                    "created_at": "2017-05-04T09:36:52.417000Z",
                    "updated_at": "2017-05-04T09:36:52.417000Z",
                    "owner": null,
                    "works": [
                        {
                            "uuid": "199e4638-f37d-46c0-ab7a-1ef99135f056",
                            "name": "易到用车TVC企业宣传片-徐小平篇",
                            "path": "default/qhBbsehenlxJaZGreXZWHSnIGTHWRrOSWCnaotfYNzEhVAkdZR.mp3",
                            "avatar": ""
                        },
                        {
                            "uuid": "5d3028e3-b200-4751-9561-e73f0ec31e2b",
                            "name": "易到用车TVC企业宣传片-姬十三篇",
                            "path": "default/79bTO9byjOqIFUO491Jav9zGkBDoNntpadl3X2Kkly2Swy76mo.mp3",
                            "avatar": ""
                        }
                    ],
                    "is_outside": true,
                    "cover": "default/TqRRsZrXOzFtWKP2ivDj8Q7N5CkoHUnrZTDpAhwRcGMYDRk0JA.png",
                    "category": "AD",
                    "name": "易到用车TVC企业宣传片",
                    "desc": "我为易到用车企业宣传片制作音乐。",
                    "start_date": "2016-01-30",
                    "end_date": "2016-02-09",
                    "budget": 30,
                    "currency": "RMB",
                    "status": "FINISHED",
                    "video": "video/徐小平.mp4",
                    "sub_category": "PROMO",
                    "need_all_copyright": true,
                    "need_sound_design": false,
                    "length": 121,
                    "period": 10
                },
                ...
            ]
        },
        ...
    ],
    ...
}

获取所有音乐人列表

(no login required)

GET /mps/

Query Pramas:

type: 音乐人类型
- PRODUCER
- BANDSMAN
- SINGER
sort: 排序方式(必填)
- ALL
- NEWEST
- HOTTEST
country：音乐人国籍（不传的话获取所有）
- China
- Overseas
search: 按照音乐人的名字来搜索

Response 200 :

{
    "count": 2,
    "next": "http://api.vfinemusic.com/v1/mps/?page=2&sort=HOTTEST&type=BANDSMAN",
    "previous": null,
    "results": [
        {
            "location": {},
            "works_likes": 4,
            "name": "刘德华",
            "avatar": "/path",
            "uuid": "2EA852B2-C109-407C-BC40-CA3DF70F3E7E",
            "level": "NORMAL",
            "desc": "我有多么牛逼balabala",
            "county": "China"
        },
        ...
    ]
}

count: 总结果数
next: 下一页的url地址，分页（生产上12个分页)
results: 结果列表

获取音乐人作品列表(非项目类)

(no login required)

GET /mps/<uuid>/works

Response 404: 用户不存在

Response 200:

{
    "results": [
        {
            "uuid": "3c3ddde2-e47f-4bb9-802b-8dc6e020a84b",
            "producer": "bbee6da4-39aa-4769-8b51-4191d2c8805e",
            "length": 0,
            "essence_start": 0,
            "essence_end": 0,
            "name": "xxx",
            "path": "",
            "desc": "",
            "avatar": "",
            "tags": [],
            "categories": [],
            "size": 0,
            "status": "ONLINE",
            "created_at": "2017-02-21 05:02",
            "type": "",
            "can_sell": false,
            "collect_count": 0,
            "username": "",
            "photo": ""
        }
    ],
    ...
}

length 音频时长,单位为秒
essence_start：精华开始时间
essence_end：精华截止时间
status 审核状态
- WAITING 等待审核
- ONLINE 审核通过
- FAIL 审核失败
- OFFLINE 已下架

2、 remarks 管理员审核备注

音乐人上传音乐

获取音乐人项目列表

(no login required)

GET /mps/<uuid>/projects

status
- ...

Response 404: 用户不存在

Response 200:

{
    "count": 14,
    "next": "http://host/v1/mps/<uuid>/projects?page=2",
    "previous": null,
    "results": [
        {
            "category": "TV",
            "uuid": "2f21f671-a9f2-4e3a-a186-6becf83e60d2",
            "level": "NORMAL",
            "created_at": "2016-10-09T05:59:55.717Z",
            "desc": "......",
            "type": "CASE",
            "name": "可口可乐，
            "cover": "/path/to/cover",
            "status": "APPLYING/ACCEPTED/REJECTED/STARTED/FISHISED"
        },
        ...
    ]
}

获取音乐人申请项目包列表

GET /mps/projects/applying/

Query params:

status
- APPLYING
- SUCCEED
- FAIL

不传的话获取音乐人申请的所有项目包列表

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "status": "APPLYING",
      "category": "TV",
      "project_name": "project_name",
      "uuid": "2f21f671-a9f2-4e3a-a186-6becf83e60d2",
      "end_date": "2016-09-12",
      "level": "NORMAL",
      "cover": "pics/26bDSBM5wD.png",
      "created_at": "2016-09-10T01:35:23.724Z",
      "short_desc": "short_desc",
      "budget": 200,
      "owner":{
        "name": 'xx',
        "uuid": 'a63dbcf4-a812-49f1-a5c6-c1b0991d17f3',
        "phone": '18611112222'
        "email": '3423rfew@qq.com'
      },
      "desc": "desc",
      "type": "WORKS",
      "start_date": "2016-09-11",
      "name": "name"
    },
    .....
  ]
}

获取音乐人申请的某一项目包的状态

GET /mp/<project_uuid>/applying

response 200

{
    "id": 1,
    "created_at": "2016-12-22T08:35:05.332000Z",
    "updated_at": "2016-12-22T08:35:05.332000Z",
    "status": "APPLYING",
    "project": "5dbee382-cd33-40fe-8c49-5fda3b08ffb7",
    "mp": 1
}

音乐人添加个人作品

POST /works/

Request body:

{
    'name': 'xxx',
    'path': 'sdas.path',
    'can_sell': True
}

name 必填
path 必填
desc 非必填
avatar 非必填
categories 分类id列表非必填
status 非必填
can_sell:(默认为false)
- True
- False
pricing_mode
owner 版权所有者信息

Response 200

{
    "uuid": "957f1f09-cfee-446a-ac33-c05f0a15e24f",
    "producer": "e2d2fc7c-b0e2-4fe0-ba8a-4c53ea0e8fec",
    "length": 0,
    "name": "xxx",
    "path": "sdas.path",
    "desc": "",
    "avatar": "",
    "categories": [],
    "size": 0,
    "status": "ONLINE",
    "created_at": "2017-02-21 05:02",
    "can_sell": true,
    "collect_count": 0,
    "owner": {
    }
}

音乐人删除个人作品

DELETE /works/<uuid>/

Response 204删除成功

音乐人更新个人作品

PUT /works/<uuid>/

Request body:

{
  'status': 'OFFLINE',
  'name': 'hehe',
  'tags': [tag1.id],
  'can_sell': True
}

Response:

{
  "uuid": "1736588e-8b68-4030-9f0c-dfa67a3c97dd",
  "producer": 1,
  "length": 0,
  "essence_start": 0,
  "essence_end": 0,
  "name": "hehe",
  "path": "",
  "desc": "",
  "avatar": "",
  "tags": [
    {
      "id": 1,
      "name": "tag1"
    }
  ],
  "categories": [],
  "size": 0,
  "status": "OFFLINE",
  "created_at": "2017-01-21 05:01",
  "type": "PERSONAL",
  "can_sell": true
}

Response 400:

This work do not belong you 这个work 不属于该音乐人

其他的选项参照上面创建works的参数，可填可不填，

音乐人风格

GET /categories/?root=musician_style

Response:

{
  "results": [
    {
      "id": 234,
      "name": "Hip-Hop",
      "real": true,
      "parent": 219,
      "children": []
    },
    ...
  ]
}

音乐人职业

GET /categories/?root=career

Response:

{
  "results": [
    {
      "id": 231,
      "name": "乐手",
      "real": false,
      "parent": 229,
      "children": [
        {
          "id": 242,
          "name": "手风琴",
          "real": true,
          "parent": 231,
          "children": []
        },
        ...
      ]
    },
    ...
  ]
}

获取实名资料

GET /users/real_name/

Response 200:

{
   "status": "SUCCESS",
   "created_at": "2016-12-02T11:46:15.433164Z",
   "name": "大姨夫",
   "id_card": "1234**********1234",
   "id_card_facade": "/path",
   "id_card_obverse": "/path"
}

status:
- WAITING
- SUCCESS
- FAIL
created_at: 申请审核日期

Response 404: 当前用户未提交申请资料
Response 200:

status=WAITING, 只返回status、created_at、name和id_card字段。
status=SUCCESS and not verify phone, 只返回status字段。
status=SUCCESS and verfify phone, 返回全部字段。
status=FAIL, 返回全部字段。

提交实名资料

POST /users/real_name/

Resquest body

{
    "name": "大姨夫",
    "id_card": "362227199501012022",
    "id_card_facade": "/path",
    "id_card_obverse": "/path"
}

通过指定用户的实名资料

PATCH /users/<uuid>/real_name/

Request body:

{
    "status": "SUCCESS"
}

7. 项目包

创建项目包

(login required)

POST /projects/

通用字段

cover 封面
category 大类，取值范围:
AD 广告
GAME 游戏
TV 影视
ANIMATION 动漫
PERSONAL 个人
COOPERATION 跨界
name 项目包名称
project_name 项目名称
short_desc 一句话描述
desc 需求详细描述
start_date 起始日期
end_date 截止日期
budget 预算(数字)
need_all_copyright 是否需要独家版权
need_sound_design 是否需要声音设计
sound_design : 只有need_sound_design 为true时需要
special_sound_effect 特殊音效补充
actual_sound_handle 同期声处理
background_noise 底噪补充制作
post_remix 后期混音
scenes: (可选) 场景信息，目前影视类和游戏有。数据类型为列表:
- name 场景名称，比如主题曲之类的
- picked 用户选择的音乐路径
- style
video. （可选）视频地址

广告类

{
    "cover": "/path/to/cover",
    "category": "AD",
    "name": "可口可乐",
    "project_name": "项目名称",
    "short_desc": "释放你的激情",
    "start_date": "2016-09-10",
    "end_date": "2016-09-11",
    "budget": 1000,
    "desc": "呵呵...",
    "need_all_copyright": true,
    "need_sound_design": true,
    "sound_design" : {
        "special_sound_effect": true,
        "post_remix": true,
        "actual_sound_handle": true,
        "background_noise": true
    }
}

个人类

{
    "cover": "/path/to/cover",
    "category": "PERSONAL",
    "name": "私人",
    "project_name": "项目名称",
    "short_desc": "个人定制",
    "start_date": "2016-09-10",
    "end_date": "2016-09-11",
    "budget": 1000,
    "desc": "呵呵...",
    "need_all_copyright": true,
    "need_sound_design": false,
    "sub_category": "MIX"
}

sub_category 声音需求
- COMPOSE 作曲
- ARRANGEMENT 编曲
- MIX 混音

跨界类

{
    "cover": "/path/to/cover",
    "category": "COOPERATION",
    "name": "跨界",
    "project_name": "项目名称",
    "short_desc": "释放你的激情",
    "start_date": "2016-09-10",
    "end_date": "2016-09-11",
    "budget": 1000,
    "desc": "呵呵...",
    "need_all_copyright": true,
    "need_sound_design": false,
    "sub_category": "MUSIC-TECH"
}

sub_category 声音需求
- MUSIC-TECH 音频技术解决方案
- MUSIC-CONTENT 音乐内容解决方案

影视类（动画电影,电影,电视剧，动画电视剧):

{
    "cover": "/path/to/cover",
    "category": "TV/ANIMATION",
    "name": "八恶人",
    "project_name": "项目名称",
    "short_desc": "释放你的激情",
    "start_date": "2016-09-10",
    "end_date": "2016-09-11",
    "budget": 1000,
    "desc": "呵呵...",
    "need_all_copyright": true,
    "need_sound_design": false,
    "content_category": "FILM",
    "director_name": "张艺谋",
    "length": 100,
    "episode_count": 1,
    "scenes": [
      {
        "name": "THEME-SONG",
        "picked": "/path/to/picked-song.mp3"
      }
    ]
}

content_category 区分影视还是连续剧，取值范围:
- FILM 电影/动画电影
- SERIES 电视连续剧/动画电视剧
director_name 导演名字
length 影片长度或者单集电视长度
episode_count: (可选) 电影类的默认为1，可不传，电视剧类的需要传此参数
sub_category 详细分类,取值范围: 'FANTASY', 'SPORTS', 'FEATURE', 'SUSPENSE', 'SCIENCE_FICTION', 'BIOGRAPHY', 'MARTIAL_ARTS', 'ACTION', 'HISTORY', 'WESTERN', 'CRIME', 'MUSIC', 'WAR', 'COMEDY', 'HORROR', 'LOVE', 'FAMILY', 'ADVENTURE', 'THRILLER', 'DISASTER', 'ETHIC'

游戏类

{
    "cover": "/path/to/cover",
    "category": "GAME",
    "name": "私人",
    "project_name": "项目名称",
    "short_desc": "释放你的激情",
    "start_date": "2016-09-10",
    "end_date": "2016-09-11",
    "budget": 1000,
    "desc": "呵呵...",
    "need_all_copyright": true,
    "need_sound_design": false,
    "platform": "WEB",
    "gender": "ALL",
    "age_area": "3+",
    "sub_category": "AA"
}

platform 游戏平台: WEB/MOBILE/CLIENT
gender 角色性别: ALL/MALE/FEMALE
age_area 适用人群: 3+/7+/12+/16+/18+/ALL
sub_category 内容分类,取值范围: 'CARD', 'FIGHTING', 'RAC', 'PUZZLE', 'BSM', 'STRATEGY', 'MUSIC', 'SPG', 'PARKOUR', 'SHOOTER', 'RPG', 'RTS', 'MOBA', 'EDU'

获取项目包详情

(no login required)

GET /projects/<uuid>/

Response 404: 相关对象不存在

Response 200:

{
    "name": "可口可乐",
    "cover": "/path/to/cover",
    "producers": [
        {
            "type": "SINGER",
            "name": "ZhangSan",
            "avatar": "/test/pics/musician_profile.png"
        },
        {
            "type": "SINGER",
            "name": "ZhangSan",
            "avatar": "/test/pics/musician_profile.png"
        }
    ],
    "owner": {
        "location": {},
        "avatar": "/test/pics/musician_profile.png",
        "name": "ZhangSan",
        "level": "NORMAL"
    },
    "works": [
        {
            "length": 6,
            "author": "Taylor Swift",
            "essence_start": 1,
            "name": "Example.ogg",
            "essence_end": 3,
             "avatar": ""
        }
    ],
    "desc": "......"
}

获取项目包列表

GET projects/?category=TV

Query Params:

category 即项目包大类，参考上面
status 项目包的状态
- APPLYING
- ACCEPTED
- ASSIGNED 待分配的项目包
- REJECTED
- STARTED
- FINISHED
- ALL 相当于[ ASSIGNED STARTED FINISHED]

Response 200:(分页)

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "category": "TV",
            "created_at": "2016-09-20T09:59:49.852Z",
            "desc": "......",
            "level": "NORMAL",
            "main_producer": {
                "name": "ZhangSan"
            },
            "name": "可口可乐",
            "type": "CASE",
            "uuid": "2F21F671-A9F2-4E3A-A186-6BECF83E60D2",
            "works": {
                "length": 6,
                "name": "Example.ogg",
                "path": "/songs/Example.ogg"
            }
        }
    ]
}

获取精品项目包列表

固定数量四个

GET /projects?type=CASE

Response 200:

{
    "data": [
        {
            "cover": "/path/to/cover",
            "name": "可口可乐",
            "uuid": "2F21F671-A9F2-4E3A-A186-6BECF83E60D2"
        }
    ]
}

8. 曲库

GET /songs/example/

Query Params

color
- RED
- PINK
- BLACK
- BLUE
- GREEN
- GREY

Resopnse 200

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 20,
      "name": "654654",
      "href": "default/5TcuiXqerUuTuMVH1Nk1VReLpPue7dS9KSV4SsGnCGCVDTalzD.exe",
      "cover_path": "",
      "color": "RED",
      "group": "CHINA",
      "created_at": "2016-12-02T11:46:15.433164Z",
      "status": "ONLINE"
    },
    {
      "id": 19,
      "name": "其味无穷二",
      "href": "default/LoPtSwgft0khP4fgTtiTxjaXP6YMCEaYgNqAh8MzD41DQbtS7r.jpeg",
      "cover_path": "",
      "color": "RED",
      "group": "CHINA",
      "created_at": "2016-12-02T11:43:42.730316Z",
      "status": "ONLINE"
    }
  ]
}

GET /v1/banner/?type=SLIDER

Query Params:

type banner分类

SLIDER 轮播图(默认4个)
MUSIC_LIBRARY 版权曲库入口图(1个)
MUSIC_PRODUCER 音乐人入口图(1个)
COOPERATION 合伙人入口图(1个)

Response 200:

{
    "data": [
        {
            "href": "x1.jpg",
            "type": "SLIDER",
            "name": "banne1"
        },
        {
            "href": "x2.jpg",
            "type": "SLIDER",
            "name": "banne2"
        },
        {
            "href": "x3.jpg",
            "type": "SLIDER",
            "name": "banne3"
        },
        {
            "href": "x4.jpg",
            "type": "SLIDER",
            "name": "banne4"
        }
    ]
}

10. 消息

（login required）

获取个人消息列表

GET /messages/

注意：该接口会附带把所有消息置为已读。

Params:

read:
- <empty> 全部
- true 已读
- false 未读

Response 200:

{
   "results":[
      {
         "type": "SYSTEM",
         "args": {"email": "support@vfinemusic.com"}
         "content": "SUCCESS_TO_MUSICIAN",
         "read": true,
         "created_at": "2016-12-26T07:27:47.393000Z",
         "id": 2,
         "title": "SUCCESS_TO_MUSICIAN"
      },
      ...
   ],
   ...
}

按时间排序，最新的在最前面.

read 已读/未读状态

获取未读消息数量

GET /messages/count/?read=false

Response body:

{
    "count": 3
}

删除指定消息

DELETE /messages/<id>/

Response:

204 成功删除

注意：以下是已废弃接口。

将消息标记为已读状态

PUT /messages/<id>/read/

Response:

204
400
- object_not_found

发送信息

POST /messages/

Request body:

{
    "title": "xx",
    "content": "vvv",
    "receiver": "xxxxxxxxxxxxxx"
}

receiver 接收人的uuid

Response 200:

{
    "content":"vvv",
    "read":false,
    "created_at":"2016-12-26T07:27:47.393000Z",
    "id":1,
    "title":"xx"
}

11. 工作台

后台创建检查点

POST /admin/checkpoints/

Request Body:

{
    'date': '2016-12-30',
    'project_uuid': '2f21f671a9f24e3aa1866becf83e60d2',
    'text': 'to do',
    'mp_id': 'mp.id'
}

date 哪一天创建检查点
project_uuid 为哪一个project创建的检查点
text 该检查点的备忘内容，可以为空字符串，
mp_id 音乐人的id

以上几个字段都是必须的，时间格式前端需要检验下

需要注意的是，一个项目包当天只有一个检查点，如果在创建的话，会覆盖前一个检查点

Response 200:

{
    "uuid": "1c42ac46-2833-4679-8d14-06ee7ce9aecd",
    "works": [],
    "date": "2016-12-30",
    "text": "to do",
    "status": "UNFINISHED",
    "producer": 1,
    "project": "b6f8d42c-ee7c-4175-92c7-97421a1c6009"
}

Response 400

The project has not started 这个项目包还没有开始，没有音乐人接单
The mp not in this project mp_id不属于当前项目包

后台修改检查点

PUT /admin/checkpoints/<uuid>

Request body:

{
    'text': 'sss',
    'date': '2016-12-29'
}

Text 非必填
date 非必填

Response 200

{
    "uuid": "1c42ac46-2833-4679-8d14-06ee7ce9aecd",
    "works": [],
    "date": "2016-12-29",
    "text": "sss",
    "status": "UNFINISHED",
    "producer": 1,
    "project": "b6f8d42c-ee7c-4175-92c7-97421a1c6009"
}

删除检查点

DELETE /admin/checkpoints/<uuid>

Response 204 删除成功

后台获取项目包检查点的状态

GET /admin/package/<uuid>/checkpoints/

Response 200:

{
    "checkpoints": [
        {
            "uuid": "7d77e1b6-d29a-4568-9613-d0253d02208d",
            "works": [],
            "date": "2016-12-24",
            "text": "to-do",
            "status": "UNFINISHED",
            "producer": 1,
            "project": "247f75d8-a5b2-475f-b23c-537783793264"
        }
    ]
}

获取当前登录用户某年某月的检查点

GET /workbenches/checkpoints/

Query Params:

status(不传的话获取下面两种情况的集合)

FINISHED
UNFINISHED

Response 200:

{
    "data": [
        {
            "uuid": "76ca7d14-2984-4490-97dc-fc1eed497426",
            "works": [],
            "date": "2016-06-23",
            "text": null,
            "status": "UNFINISHED",
            "producer": 1,
            "project": "c7aa106f-bc23-4440-9882-3b2cc1ca0f8f"
        },
        {
            "uuid": "b423d4d2-2743-4138-8c42-74aad4aeb992",
            "works": [],
            "date": "2016-12-23",
            "text": "to-do",
            "status": "UNFINISHED",
            "producer": 1,
            "project": "c7aa106f-bc23-4440-9882-3b2cc1ca0f8f"
        }
    ]
}

音乐人在某一检查点上添加works

POST /workbenches/checkpoints/<uuid>/work/

Request Body:

{
    'name': 'name1',
    'path': 'work1'
}

name 歌曲姓名
歌曲路径

后台admin可以复用此接口

Response 200：

{
    "uuid": "6efe8012-e708-4ecc-a84e-1b2e9eb0e132",
    "works": [
        {
            "uuid": "ac63a9a2-2475-4257-a324-f72d8f530b56",
            "producer": 1,
            "length": 0,
            "essence_start": 0,
            "essence_end": 0,
            "name": "name1",
            "path": "work1",
            "desc": "",
            "avatar": "",
            "tags": [],
            "categories": [],
            "size": 0,
            "status": "ONLINE",
            "created_at": "2016-12-26 07:12"
        }
    ],
    "date": "2016-12-23",
    "text": "xxx",
    "status": "UNFINISHED",
    "producer": 1,
    "project": "2e0eafab-0e3d-43c4-a5fa-50bfda00b3d7"
}

Respose 400:

You should finish checkpoint: 之前还有检查点没有完成
This checkpoint is not for you. 该检查点不属于该音乐人

音乐人删除某一检查点上的works

后台admin可以复用此借口

DELETE /workbenches/checkpoints/<uuid>/work/

Request body:

{
    'works': ['ac63a9a2-2475-4257-a324-f72d8f530b56', '99832ecb-9a7c-4275-8a89-3672fa8bd64a']
}

Response 204: 删除成功

Response 400：

The work not in this checkpoint 这个work 不属于这个检查点
This checkpoint is not for you. 该检查点不属于改音乐人

获取某一个检查点的验收情况

GET /workbenches/checkpoints/<uuid>/acceptance/

Response 200:

[
    {
        "id": 1,
        "created_at": "2016-12-26T07:27:47.393000Z",
        "updated_at": "2016-12-26T07:27:47.393000Z",
        "mp_message": "demo-1",
        "client_message": "demo-1 unsatisfied",
        "status": "UNSATISFIED",
        "cp": "2eaa07b8-7073-4398-b062-6fae5ea61e09",
        "client": "6100915e-d7b6-4a5a-b46f-a089557a2106"
    },
    {
        "id": 2,
        "created_at": "2016-12-26T07:27:47.393000Z",
        "updated_at": "2016-12-26T07:27:47.393000Z",
        "mp_message": "demo-2",
        "client_message": "ok",
        "status": "SATISFIED",
        "cp": "2eaa07b8-7073-4398-b062-6fae5ea61e09",
        "client": "6100915e-d7b6-4a5a-b46f-a089557a2106"
    }
]

音乐人提交验收

POST /workbenches/checkpoints/<uuid>/acceptance/

Request body:

{
    'message': 'demo-1'
}

Response 200:

{
    "id": 1,
    "created_at": "2016-12-26T07:31:44.717000Z",
    "updated_at": "2016-12-26T07:31:44.717000Z",
    "mp_message": "",
    "client_message": "demo-1",
    "status": "UNSATISFIED",
    "cp": "8c870d1b-5931-4386-96ad-ca19dfee6152",
    "client": "33d50f03-f6fd-4ad0-88a5-7cc4ce5625c7"
}

Response 400:

Add works for this checkpoint first 这个检查点还没有添加demo
This checkpoint is not for you. 该检查点不属于改音乐人

客户获取某一项目下面的检查点状态

GET /projects/<uuid>/checkpoints/

Response 200:

{
    "checkpoints": [
        {
            "uuid": "c0fd39c0-3b4c-4cf6-86ab-f73559f967c3",
            "works": [
                {
                    "uuid": "ff61c576-ba0b-4524-9c82-fc33ba32f237",
                    "producer": 1,
                    "length": 0,
                    "essence_start": 0,
                    "essence_end": 0,
                    "name": "work1",
                    "path": "",
                    "desc": "",
                    "avatar": "",
                    "tags": [],
                    "categories": [],
                    "size": 0,
                    "status": "ONLINE",
                    "created_at": "2016-12-26 07:12"
                }
            ],
            "date": "2016-12-23",
            "text": "xxx",
            "status": "UNFINISHED",
            "producer": 1,
            "project": "247f75d8-a5b2-475f-b23c-537783793264"
        },
        {
            "uuid": "7d77e1b6-d29a-4568-9613-d0253d02208d",
            "works": [],
            "date": "2016-12-24",
            "text": "to-do",
            "status": "UNFINISHED",
            "producer": 1,
            "project": "247f75d8-a5b2-475f-b23c-537783793264"
        }
    ]
}

Response 400

This project is not for you 该项目包不属于该客户创建

客户验收某一检查点

PUT /workbenchs/acceptance/<id>/

Request body:

{
  'message': 'demo is ok',
  'status': 'SATISFIED'
}

status
- SATISFIED
- UNSATISFIED

满意的时候 message 可以为空字符串

不满意的时候， message 不能为空

Response 200：

{
    "id": 1,
    "created_at": "2016-12-26T07:42:45.977000Z",
    "updated_at": "2016-12-26T07:42:45.991000Z",
    "mp_message": "demo-1",
    "client_message": "demo is ok",
    "status": "SATISFIED",
    "cp": "a0adcc4d-15db-4669-9d67-17b3176ba7b0",
    "client": "24755426-c056-45c6-9a85-548d4ec9eb36"
}

Response 400:

This acceptance is not fot you 这个检查点不是由该客户来验收
You must leave a message 验收不满意的时候传过来一个空字符串

获取某一项目的进度

GET /workbenches/project/checkpoints/

Query Params

uuid 项目的uuid

Response 200

{
    "data": "2/6"
}

12. 版权曲库销售前端

获取全部标签列表

GET /categories/

Response 200:

{
  "results": [
    {
      "id": 1,
      "name": "风格",
      "parent": null,
      "real": false,
      "children": [
        {
          "id": 3,
          "name": "摇滚",
          "real": true,
          "parent": 1,
          "children": []
        },
        ...
      ]
    },
    ...
  ]
}

获取风格列表

GET /categories/?root=风格&struct=flat

Response 200:

{
    "results": [
        {
            "id": 29,
            "name": "摇滚",
            "real": false,
            "parent": 163
        },
        ...
    ]
}

获取平台作品

GET /works/

params:

categories 风格标签id，用逗号隔开，例如：1,2
ordering
search

Response 200:

{
  "count": 4,
  "next": null,
  "previous": null,
  "results": [
    {
      "username": "谭维维",
      "photo": "/test/pics/musician_profile.png",
      "path": "/songs/Example.ogg",
      "essence_start": 1,
      "desc": "测试音频文件",
      "name": "Example.ogg",
      "uuid": "dd3b44f8-ef46-41b9-beb9-dfdc3a9353db",
      "essence_end": 3,
      "length": 6,
      "avatar": "",
      "type": "PRODUCER"
    },
    ...
  ]
}

获取统一定价方案

GET /pricing/

Response body:

{
    "purpose": [
        {
            "name": "广告/宣传片",
            "question": "请选择您的投放渠道",
            "detail": [
                {
                    "name": "全渠道投放",
                    "price": 500.0
                },
                ...
            ]
        },
        ...
    ]
}

添加音乐到购物车

POST /cart/

Request body:

{
    "work": <work uuid>,
    "purpose": "广告/宣传片",
    "detail": "全渠道投放"
}

Response 201: 添加成功

获取购物车列表

GET /cart/

Response body:

{
    results: [
        {
            "id": 1,
            "purpose": "广告/宣传片",
            "detail": "全渠道投放",
            "pricing": 500.0,
            "work": {
                "uuid": <uuid>,
                "name": "_name_",
                "path": "/path.mp3",
                "producer": {
                    "uuid": <uuid>,
                    "name": "_name_"
                }
            }
        },
        ...
    ]
}

从购物车删除音乐

DELETE /cart/<id>/

Response 204: 删除成功

生成订单

POST /orders/

mode
- COMPANY
- PERSONAL

Request body:

{
    "name": <name>,
    "phone": <phone>,
    "mode": "COMPANY",
    "company": <company name>,
    "address": <company address>,
    "works": [
        {
            "uuid": <uuid>,
            "purpose": "商业广告/宣传片",
            "channel": "全渠道投放"
        },
        ...
    ]
}

Response 200:

{
    支付服务返回的结果
}

获取订单列表

POST /orders/

Request params:

status:
- <empty> 所有
- FINISHED 已完成
- UNFINISHED 未完成
- CANCELED 已取消

Response body:

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "uuid": "9b44d5ae-f099-4ae1-846e-34e4c8a7b458",
            ...
        },
        ...
    ]
}

获取订单详情

POST /orders/<uuid>/

Response body:

{
    "uuid": "9b44d5ae-f099-4ae1-846e-34e4c8a7b458",
    "name": "大姨夫",
    "phone": "+8618515355024",
    "company": "音未",
    "address": "五道口",
    "price": "500.00",
    "payment_method": null,
    "payment_number": null,
    "certificates": [
        {
            "uuid": "68e01d72-3959-4463-bc66-b09405615ea2",
            "author": "富宇",
            "licensee": "Admin",
            "work_name": "saxsmooth",
            "work_path": "songs/SIk4YzGuA84R0yoYkl3156eJocbpGJdCpsEvf2xMmvUpjpjUBx.mp3",
            "work": {
                "uuid": "06fbadf2-2d19-4fad-b57d-ac4f51c2c077",
                "avatar": "/path"
            },
            "purpose": "商业广告/宣传片",
            "channel": "全渠道投放",
            "price": "500.00",
            "income": "0.00",
            "order": "9b44d5ae-f099-4ae1-846e-34e4c8a7b458"
        }
    ]
}

uuid: 订单号

去支付

GET /orders/<uuid>/pay/

取消订单

DELETE /orders/<uuid>/

Response 204 : 取消成功

获取已购买音乐授权

GET /certificates/

Response body:

{
    results: [<certificate>, ...],
    ...
}

获取指定授权

GET /certificates/<uuid>/

Response body:

{
    "uuid": "4f08e0ad-8475-462b-9371-48e541eafaa8",
    "author": "eigenTunes亦听",
    "licensee": "Admin",
    "work_name": "漫步星空",
    "work_path": "/path.mp3",
    "work": {
        "uuid": "2dc065a3-239f-45ae-ba6c-cf17636b8dd3",
        "name": "漫步星空",
        "path": "/path.mp3",
        "avatar": "/path.jpg",
        "producer": {
            "uuid": <uuid>,
            "name": "eigenTunes亦听"
        }
    },
    "purchase_date": "2017-05-08T10:15:02.402000Z",
    "purpose": "广告/宣传片",
    "detail": "全渠道投放",
    "price": "0.01",
    "income": "0.00",
    "order": "184d37c2-b836-479e-aa8b-2991ff3781d3"
}

下载证书

GET /certificates/<uuid>[.txt|.pdf]

uuid: 授权单号

收益总计

GET /income/total/

Response body:

{
    "data": {
        "balance": "898.00",
        "total_income": "1000.00",
        "current_month_income": "26.00",
        "total_order": 5,
        "current_month_order": 3
    }
}

收益明细

GET /income/

Response body:

{
    results: [
        {
            "uuid": "4f08e0ad-8475-462b-9371-48e541eafaa8",
            "purchase_date": "2017-05-08T10:15:02.402000Z",
            "work_name": "漫步星空",
            "licensee": "Admin",
            "price": "100.00",
            "income": "89.00"
        }
    ],
    ...
}

uuid: 交易编号
purchase_date: 交易时间
work_name: 音乐名
licensee: 客户
price: 成交额
income: 收益额

绑定收款账户

POST /pay_account/

Request body:

{
    "type": "alipay”,
    "account": "dayifu"
}

获取收款账户

GET /pay_account/

Response body:

{
    "type": "alipay”,
    "account": "da*ifu"
}

Response 404: 未绑定

修改支付账户

PUT /pay_account/

Request body:

{
    "type": "alipay",
    "account": "dayifu"
}

申请提现

POST /takeout/

Request body:

{
    money: 100.0
}

amount: 要提现的金额

提现明细

GET /takeout/

status: 提现状态
- REQUESTING 申请中
- WAITING 待转账
- SUCCESS 提现成功
- FAIL 申请失败
- CANCEL 已取消

{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "uuid": <uuid>,
            "status": "REQUESTING",
            "created_at": "2016-12-02T11:46:15.433164Z",
            "money": "100.00",
            "transfer_money": "90.00",
            "name": "dayifu",
            "id_card": "345678905678",
            "balance": 300
        }
    ]
}

13. 用戶提交建议

提交建议

POST /suggestions/

Request body

{
    "username": "xx",
    "text": "xzcz",
}

Response 200

14. 购买歌曲相关

用户提交购买申请

需要登录才能购买

POST /users/purchase-work/

Request body:

{
    'uuid': 'ac20265d-91b7-4375-a689-b5d0f4e6fa2c',
    'remark': 'xxxx'
}

uuid 要购买的歌曲uuid
remark 提交购买时候的备注（非必填）

Response body:

{
    "id": 1,
    "remark": "xxxx",
    "date": "2017-01-19",
    "status": "APPLY",
    "user": "e1d6054f-8e97-4569-b3f0-4a654a9bd1ec",
    "work": "7f6552a7-fc19-4ebc-a23b-1bf6a408514b"
}

Response 400

This song can not purchase. 这首歌暂时不支持购买

15. 下单接单相关

音乐人接单

POST /projects/<uuid>/order/

uuid 为所接项目包 uuid

Request body:

{
  quote: 222,
  message: "xx",
  demo: {
    "xx": 'xx'
  }
}

quote，报价
message 非必填
demo 以往相关项目链接（json）

Response 200

{
    "id": 1,
    "project": "44e5d65a-d3c5-46c8-9d01-ed2bb0d7112d",
    "quote": 222,
    "message": "xxx",
    "is_candidate": false,
    "backend": {},
    "weight": 0,
    "mp_id": "1",
    "mp_uuid": "22fdbdc1-acc9-42e2-9b6a-1b74a9b63026",
    "username": "jason",
    "avatar": "",
    "demo": {
        "xx": "xx"
    },
    "created_at": "2017-02-23T08:32:10.130912Z",
    "status": "APPLYING"
}

Response 400

Already apply 该项目包该用户已经申请过了

音乐人取消接单

DELETE /projects/<uuid>/order/

Response 204 取消接单成功

Response 400 You did not have applied before（该音乐人没有申请接单）

获取一个项目包申请接单的列表

GET /projects/<uuid>/applying/

uuid 为项目包的uuid

Query params 默认的排序是weight从大到小

is_candidate
- true
- false

Response 200：

[
   {
        "id": 1,
        "project": "7513f3f8-0b56-4c0d-955f-127a0be3f818",
        "quote": 0,
        "message": "",
        "is_candidate": true,
        "backend": null,
        "weight": 22,
        "mp_id": "1",
        "mp_uuid": "654649ad-4010-4a61-a544-d469487fbd37",
        "username": "",
        "avatar": "",
        "demo": null,
        "created_at": "2017-02-23T07:32:00.986719Z",
        "status": "APPLYING"
    },    {
        "id": 2,
        "project": "7513f3f8-0b56-4c0d-955f-127a0be3f818",
        "quote": 0,
        "message": "",
        "is_candidate": false,
        "backend": null,
        "weight": 11,
        "mp_id": "2",
        "mp_uuid": "4cc5f71d-706b-4b95-b787-eee03f302847",
        "username": "",
        "avatar": "",
        "demo": null,
        "created_at": "2017-02-23T07:32:00.987064Z",
        "status": "APPLYING"
    }
]

后台对项目包添加申请人

POST /admin/projects/<uuid>/applying/

Request data:

{
    'mp': mp.id,
    'quote': 444,
    'backend': {
    'xx': 'ss'
    }
}

mp, 音乐人的id（必填）

其他支持的选项为

quote，申请的金额
message,音乐人申请的留言
backend 备选的信息（json）
demo 备选的demo的（json）
weight 排序的权重，（int）

Response 200:

{
    "id": 1,
    "project": "1e0d1ed9-495a-41a3-acb1-12fd6ab5171b",
    "quote": 444,
    "message": "",
    "is_candidate": false,
    "backend": {
        "xx": "ss"
    },
    "weight": 0,
    "mp_id": "1",
    "mp_uuid": "2e04e008-a402-49bc-8c6a-7dfe917b1881",
    "username": "",
    "avatar": "",
    "demo": {},
    "created_at": "2017-03-15T07:17:41.629533Z",
    "status": "APPLYING"
}

后台对申请接单列表排序或修改

PUT /admin/projects/applying/

Request body:

{
  'applying': str(applying1.id),
  'weight': 22,
  'backend': {
    'xx': 'xx'
  },
  'status': const.PROJECT_APPLY_FAIL
}

applying id必传
weight 非必填数字越大排序越前
backend 非必填，json字段，

Response body

{
  "id": 1,
  "project": "7016c2da-3f37-4288-b1fe-382807c85f65",
  "quote": 0,
  "message": "",
  "is_candidate": false,
  "backend": {
    "xx": "xx"
  },
  "weight": 22,
  "mp_id": "1",
  "mp_uuid": "e83532a0-a561-4a82-b3db-e10050a4a30a",
  "username": "",
  "avatar": "",
  "demo": {},
  "created_at": "2017-02-23T09:17:31.518870Z",
  "status": "FAIL"
}

客户从接单列表里面选择候选人

PUT /projects/<uuid>/applying/

Request body:

{
  'applying': [1, 2]
}

Response 204 (挑选成功)

从项目包接单的音乐人中选取一个作为项目包最后的接单人

POST /admin/packages/manager/

Request Body:

{
    'project_id': '2f21f671a9f24e3aa1866becf8311111',
    'manager_id': '1'
}

Response 204 接单成功

Response 400 这个项目包已经有人接了

{
     "message": "Manager has been add",
     "code": "action_already_done"
}

获取一个项目包下面所属检查点的所有works

GET /projects/<uuid>/cps/works/

Response 200

[
    {
        "uuid": "c4d07336-53fc-441c-abaa-d8b74c4cd678",
        "producer": "f1462bad-7fdd-49ef-89bd-3f19e824e442",
        "length": 0,
        "essence_start": 0,
        "essence_end": 0,
        "name": "",
        "path": "",
        "desc": "",
        "avatar": "",
        "tags": [],
        "categories": [],
        "size": 0,
        "status": "ONLINE",
        "created_at": "2017-03-06 09:03",
        "type": "",
        "can_sell": false,
        "collect_count": 0,
        "username": "jason",
        "photo": ""
    }
]

客户从中检查点的works挑选几个作为项目包的works

POST /projects/<uuid>/cps/works/

Request body:

{
    'works': ["c4d07336-53fc-441c-abaa-d8b74c4cd678", ]
}

Response 204 添加成功

Response 400 This project is not for you

Response 400 This work can not be add to project. ,该works不属于该项包下的检查点

16. 下载

下载歌曲

加不加水印自动做了处理，前端无需判断

GET /songs/<uuid>/download/

Response 302 重定向到歌曲资源处

Response 400 Have no permission for this song 没有权限

获取强推音乐列表

GET /works/star/
按照统一的音乐格式返回即可

获取强推音乐人列表

GET /mps/star/

Response body:

{
    "results": [
        {
            "name": "Musician1",
            "another_musician_info": "a",
            "can_sell_list": [
                "work",
                "work"
            ]
        }
    ]
}

需给出音乐人列表和该音乐人可售卖音乐列表

OPS 删除强推音乐

DELETE /works/star/

Request body:

{
    "pk": <uuid>
}

OPS 添加强推音乐

POST /works/star

Request body:

{
    "pk": <uuid>
}

OPS 删除强推音乐人

DELETE /mps/star/

Request body:

{
    "pk": <uuid>
}

OPS 添加强推音乐人

POST /mps/star/

Request body:

{
    "pk": <uuid>
}

获取待审核实名列表

获取待审核的实名列表

GET /real_name/

Response 200:

{
    "results": [
        {
            "user": {
                "uuid": "3c3ddde2-e47f-4bb9-802b-8dc6e020a84b",
                "name": "大姨夫"
            },
            "name": "李四",
            "created_at": "2016-12-02T11:46:15.433164Z",
            "id_card": "1234**********1234",
            "id_card_facade": "/path",
            "id_card_obverse": "/path"
        }
    ],
    ...
}

审核实名资料

PATCH /users/<uuid>/real_name/

之前的接口是一个SUCCESS的状态，只允许通过，现在需要有拒绝的操作

status:
- SUCCESS 审核通过
- FAIL 审核失败

Request body:

{
    "status": " SUCCESS / FAIL"
}

音乐人曲库

GET /songs/works/

售卖音乐增加审核状态筛选 status：

WAITING 待审核
ONLINE 通过
FAIL 拒绝
OFFLINE 下架

每个音乐增加售卖次数和最近售卖时间：

sell_count: 8 售卖次数
sell_lasted: '43255345' 最近售卖时间

API文档

撤回作品审核

音乐人上传音乐

音乐人更新个人作品

OPS 编辑音乐

OPS 音乐审核

获取音乐人自己的作品

获取指定音乐人的作品

提现记录

提现审核

API详细文档

1. auth

注册

检查用户是否存在

登录

登出

发送验证码

检查验证码

2. 用户个人管理

检查密码是否正确

更改密码

更换手机

更换邮箱

更新用户profile

获取用户profile

更新用户关系(关注/取关)

收藏或者取消收藏work

获取用户收藏歌曲的列表

获取粉丝列表

获取关注列表

获取个人创建的项目包列表

删除个人创建的项目包（只删除被后台拒绝的项目包）

通过手机或邮箱来修改密码

3. 用户信息

获取其他用户profile

4. 文件存储

获取存储服务相关信息

5. 组

创建组

将其他用户添加进组

6. 音乐人相关

音乐人认证

获取认证状态

筛选定制音乐人

获取所有音乐人列表

获取音乐人作品列表(非项目类)

获取音乐人项目列表

获取音乐人申请项目包列表

获取音乐人申请的某一项目包的状态

音乐人添加个人作品

音乐人删除个人作品

音乐人更新个人作品

音乐人风格

音乐人职业

获取实名资料

提交实名资料

通过指定用户的实名资料

7. 项目包

创建项目包

获取项目包详情

获取项目包列表

获取精品项目包列表

8. 曲库

9. Banner

获取banner

10. 消息

获取个人消息列表

获取未读消息数量

删除指定消息

将消息标记为已读状态

发送信息

11. 工作台

后台创建检查点

后台修改检查点

删除检查点

后台获取项目包检查点的状态

获取当前登录用户某年某月的检查点

音乐人在某一检查点上添加works

音乐人删除某一检查点上的works

获取某一个检查点的验收情况