内容库操作

获取内容库详情

接口

GET https://cloud.minapp.com/oserve/v2.2/content/:content_group_id/

其中 content_group_id 是内容库的 ID

代码示例

  1. curl -X GET \
  2. -H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \
  3. -H "Content-Type: application/json" \
  4. https://cloud.minapp.com/oserve/v2.2/content/1/
  1. var request = require("request");
  3. var options = { method: 'GET',
  4.   url: 'https://cloud.minapp.com/oserve/v2.2/content/1/',
  5.   headers: 
  6.    { 'Content-Type': 'application/json',
  7.      Authorization: 'Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4' } };
  9. request(options, function (error, response, body) {
  10.   if (error) throw new Error(error);
  12.   console.log(body);
  13. });
  1. <?php
  2. $content_group_id = 1; // 内容库的 ID
  3. $url = "https://cloud.minapp.com/oserve/v2.2/content/{$content_group_id}/";
  5. $ch = curl_init();
  6. $header = array(
  7.   "Authorization: Bearer {$token}",
  8.   'Content-Type: application/json; charset=utf-8'
  9. );
  11. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  12. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  13. curl_setopt($ch, CURLOPT_URL, $url);
  14. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
  15. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  16. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  18. $res = curl_exec($ch);
  19. curl_close($ch);

返回示例

  1. {
  2.   "id": 1,
  3.   "name": "内容库",
  4.   "acl_gids": [],
  5.   "created_at": 1489137188,
  6.   "updated_at": 1495769882
  7. }

获取内容库列表

接口

GET https://cloud.minapp.com/oserve/v2.2/content/

该接口支持通过参数 return_total_count 指定是否返回查询对象总数，以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。同时，从 v2.2 版本开始该接口默认不返回查询对象总数，欲获取总数的开发者需要显式指定 return_total_count 参数。

提交参数

  • name 内容库名称等值查询查询

例：查询内容库名称为 "内容库1" 的内容库

https://cloud.minapp.com/oserve/v2.2/content/?name=内容库1

  • return_total_count 指定是否在 meta 中返回 total_count

例：指定返回 total_count

https://cloud.minapp.com/oserve/v2.2/content/?return_total_count=1

若开发者只需要获取对象总数，则可以通过设置 limit=1 以及 return_total_count=1 来达到该效果，total_count 可从返回的 meta 中获取

请求示例：

  1. https://cloud.minapp.com/oserve/v2.2/content/?limit=1&return_total_count=1

代码示例

  1. curl -X GET \
  2. -H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \
  3. -H "Content-Type: application/json" \
  4. https://cloud.minapp.com/oserve/v2.2/content/
  1. var request = require("request");
  3. var options = { method: 'GET',
  4.   url: 'https://cloud.minapp.com/oserve/v2.2/content/',
  5.   headers: 
  6.    { 'Content-Type': 'application/json',
  7.      Authorization: 'Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4' } };
  9. request(options, function (error, response, body) {
  10.   if (error) throw new Error(error);
  12.   console.log(body);
  13. });
  1. <?php
  2. $url = "https://cloud.minapp.com/oserve/v2.2/content/";
  4. $ch = curl_init();
  5. $header = array(
  6.   "Authorization: Bearer {$token}",
  7.   'Content-Type: application/json; charset=utf-8'
  8. );
  10. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  11. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  12. curl_setopt($ch, CURLOPT_URL, $url);
  13. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
  14. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  15. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  17. $res = curl_exec($ch);
  18. curl_close($ch);

返回示例

{
  "meta": {
    "limit": 20,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 1
  },
  "objects": [
    {
      "id": 1,
      "name": "内容库",
      "acl_gids": [],
      "created_at": 1489137188,
      "updated_at": 1495769882
    }
  ]
}

创建内容库

接口

POST https://cloud.minapp.com/oserve/v2.2/content/

参数说明

Content-Type: application/json

参数类型必填说明
nameStringY内容库名称
acl_gidsInteger ArrayN用户的访问权限，其内为分组 ID

代码示例

curl -X POST \
-H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \
-H "Content-Type: application/json" \
-d '{
      "name": "Content Group",
      "acl_gids": [1, 2]
    }' \
https://cloud.minapp.com/oserve/v2.2/content/
var request = require("request");

var options = { method: 'POST',
  url: 'https://cloud.minapp.com/oserve/v2.2/content/',
  headers: 
   { 'Content-Type': 'application/json',
     Authorization: 'Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4' },
  body: { name: 'Content Group', acl_gids: [ 1, 2 ] },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

<?php
$param['name'] = 'CreateContentGroup';
$param['acl_gids'] = [1, 2];
$url = 'https://cloud.minapp.com/oserve/v2.2/content/';

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: application/json; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
$res['response'] = curl_exec($ch); // 反馈结果
$res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
curl_close($ch);

返回示例

{
  "id": 2,
  "name": "Content Group",
  "acl_gids": [1, 2],
  "created_at": 1489137188,
  "updated_at": 1495769882
}

状态码说明

201: 创建成功

400: 用户组 ID 不合法

编辑内容库

接口

PUT https://cloud.minapp.com/oserve/v2.2/content/:content_group_id/

代码示例

curl -X PUT \
-H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \
-H "Content-Type: application/json" \
-d '{
      "name": "Test Group"
    }' \
https://cloud.minapp.com/oserve/v2.2/content/2/
var request = require("request");

var options = { method: 'PUT',
  url: 'https://cloud.minapp.com/oserve/v2.2/content/2/',
  headers: 
   { 'Content-Type': 'application/json',
     Authorization: 'Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4' },
  body: { name: 'Test Group' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
<?php
$content_group_id = 1; // 内容库的 ID
$url = "https://cloud.minapp.com/oserve/v2.2/content/{$content_group_id}/";
$param['name'] = 'UpdateContentGroup';

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: application/json; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$res['response'] = curl_exec($ch); // 反馈结果
$res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
curl_close($ch);

返回示例

{
  "id": 2,
  "name": "Test Group",
  "acl_gids": [1, 2],
  "created_at": 1489137188,
  "updated_at": 1495769882
}

状态码说明

200: 修改成功

400: 用户组 ID 不合法

删除内容库

接口

DELETE https://cloud.minapp.com/oserve/v2.2/content/:content_group_id/

代码示例

curl -X DELETE \
-H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \
-H "Content-Type: application/json" \
https://cloud.minapp.com/oserve/v2.2/content/2/
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://cloud.minapp.com/oserve/v2.2/content/2/',
  headers: 
   { 'Content-Type': 'application/json',
     Authorization: 'Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

<?php
$content_group_id = 1; // 内容库的 ID
$url = "https://cloud.minapp.com/oserve/v2.2/content/{$content_group_id}/";

$ch = curl_init();
$header = array(
  "Authorization: Bearer {$token}",
  'Content-Type: application/json; charset=utf-8'
);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

$res['response'] = curl_exec($ch); // 反馈结果
$res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
curl_close($ch);

状态码说明

204: 删除成功