Putian Integration API

zhihui

Note

• 普天智汇里面内建了普天运营渠道,账户/密码：admin/111111。
• 渠道用户登录后，首先应该根据自己存储总量规划对渠道容量进行更新，默认为0。
• 更新渠道总容量后，通过调用创建渠道公司API(Create channel company and company admin user)来创建公司和公司管理员
• 创建公司之后，可以更新公司存储容量（Upate channel company quota）
• 通过调用用户信息API（Get user info）可以获取用户基本信息

User Login

Description

Login mbk user.

URL

/api/user/ologin/

Method

POST

Content-Type

application/x-www-form-urlencoded

Parameter

{
    "grant_type": "passowrd",
    "client_id": "0Oq62d5HeW1sbQ5gD2jF6KBjzizqKsaO7MhBRfR3",
    "client_secret":"6vFeolOrASGD20RYJAuceBktE4UUyPLFfjqS91fV4tZomzh1XNKO4hxe3vXxWpgtEcmamgRUvOhIjT4aJKPQT3HdJ5qx5FyjMA8x2sYs5CNTAeegExkVJvDoANOVqKCz",
    "username": "admin",
    "password": "111111"
}

Return - Success

Status Code: 200
Body: 
{
    "token_type": "*****",
    "access_token": "*****",
    "expiries_in": "*****",
    "expires_at": "*****"
}

Return - Fail

1. Username or password not correct

Status Code: 400

Create channel company and company admin user

Description

 Create channel company and company admin user

URL

/api/user/channel/channel_company/

Method

POST 

Authorization

Bearer {access_token}

Parameter

{
"is_key_managed":true,
"company_name":"普亚科技",
"company_tel":"025-178721788",
"username":"puya",
"email": "woods2001@126.com",
"password":"111111",
"quota":100,
"expired_time":"2017-04-30 00:00:00"
}

Return - Success

Status Code: 200 OK

Return - Fail

1. Data format error

Status Code: 400
Body:   {
  "detail": "JSON parse error - Expecting property name enclosed in double quotes: line 6 column 1 (char 167)"
}

Upate channel company quota

Description

Update channel company quota

URL

/api/user/channel/channel_company/quota/

Method

POST

Authorization

Bearer {access_token}

Parameter

{
    "cid":6,
    "quota":150，
    "expired_time":"2017-05-30 10:00:00"
}

Return - Success

Header: 200 OK

Return - Fail

1. Request quota is over the remain quota of channel

Status Code: HTTP_413_REQUEST_ENTITY_TOO_LARGE

1. Field Miss/Invalid error

Status Code: 406
Body:   {
  "ret": 2,
  "reason": "quota and cid field needed"
}

Get user info

Description

Get user info

URL

/api/user/info/

Method

GET

Authorization

Bearer {access_token}

Return - Success

Status Code: 200
Body: 
{
    "email_need_bind": false,
    "user_type": 5,
    "devices_used": 1,
    "user_active": true,
    "id": 12,
    "is_email_confirmed": true,
    "company_name": "南京普亚",
    "email": "salt_yang@puyacn.com",
    "channel": 1,
    "username": "puya",
    "used": 509874270,
    "is_cellphone_binded": false,
    "quota": 0,
    "cert_status": 5,
    "is_admin": true,
    "paid_quota": 96636764160,
    "nickname": null,
    "is_key_managed": false,
    "cellphone": null,
    "cid": 2,
    "is_user_active": true,
    "channel_name": "南京普天",
    "is_email_binded": true
}

Update user password

Description

Update user password

URL

/api/user/${user_id}/

Method

PUT

Authorization

Bearer {access_token}

Parameter

{
    "oldpassword": "111111"
    "password": "puyacn#1.."
}

Return - Success

Status Code: 200

Change company status

Description

Change company status: 1 -> active, 0 -> frozen

URL

/api/user/channel/channel_user/status/

Method

PUT

Authorization

Bearer {access_token}

Parameter

{
    "cid":2,
    "status":0
}

Return - Success

Status Code: 200

Return - Failed

• Field error/missed

Status Code: 406
body: 
{
    "ret": REST_ERR_FIELD_ERR/REST_ERR_FIELD_MISS, 
    "reason": "status field error"/"status field error"}
}

Delete company

Description

It can delete company and company admin user succefully after the company/user has frozened 7 days.

URL

/api/user/channel/channel_user/del/

Method

POST

Authorization

Bearer {access_token}

Parameter

{
    "cid": 2  
}

Return - Success

Status Code: 200

Return - Failed

• user is not channel admin

Status Code: 406
body: 
{
    "ret": REST_ERR_OPS_VALID,
    "reason": "user is not channel admin"
}

• company is actived

Status Code: 406
body: 
{
    "ret": REST_ERR_USER_NOT_FROZEN, 
    "reason": "company is actived"
}

• The frozend time of company doesn't over 7days

Status Code: 406
body: 
{
   "ret": REST_ERR_USER_IN_FROZEN,
    "reason": frozen_duration
}

Upate cloud storage

Description

Update cloud storage

URL

/api/storage/cloud/

Method

POST

Authorization

Bearer {access_token}

Parameter

{
    credentials: [
    {
        "access_key":"WLG36LHZ1HXERPTRH4H9",
        "access_secret":"qZXfctq9tMZfIJhcULiW4CnuqBqCejsVlEz2X2Du",
        "bucket":"bucket4",
        "url":"116.62.61.218"
    },
    {
        "access_key":"WLG36LHZ1HXERPTRH4H9",
        "access_secret":"qZXfctq9tMZfIJhcULiW4CnuqBqCejsVlEz2X2Du",
        "bucket":"bucket4",
        "url":"116.62.61.218"
    },
    {
        "access_key":"WLG36LHZ1HXERPTRH4H9",
        "access_secret":"qZXfctq9tMZfIJhcULiW4CnuqBqCejsVlEz2X2Du",
        "bucket":"bucket4",
        "url":"116.62.61.218"
    },
    {
        "access_key":"WLG36LHZ1HXERPTRH4H9",
        "access_secret":"qZXfctq9tMZfIJhcULiW4CnuqBqCejsVlEz2X2Du",
        "bucket":"bucket4",
        "url":"116.62.61.218"
    },
    {
        "access_key":"WLG36LHZ1HXERPTRH4H9",
        "access_secret":"qZXfctq9tMZfIJhcULiW4CnuqBqCejsVlEz2X2Du",
        "bucket":"bucket4",
        "url":"116.62.61.218"
    }
    ]
}

Return - Success

Header: 200 OK

Return - Fail

1. Request quota is over the remain quota of channel

Status Code: HTTP_413_REQUEST_ENTITY_TOO_LARGE

1. Field Miss/Invalid error
   ```python
   Status Code: 406
   Body: {
   "ret": 2,
   "reason": "quota and cid field needed"
   }