附件

上传附件

此接口只用于创建附件实体,不负责文件传输。开发者需先通过 文件上传 接口将文件上传于腾讯云,再把state通过此接口把文件和实体关联起来。

附件创建成功后,可提取附件id,用于在创建文档编辑文档 时关联附件。

接口调用说明:

POST https://lxapi.lexiangla.com/cgi-bin/v1/attachments?state={$state}

请求document

{
    "data":{
        "type":"attachment",
        "attributes":{
            "name": "附件名",
            "downloadable": 0
        }
    }
}

参数说明:

参数 是否必须 默认值 说明
type 资源对象类型,必须为 attachment,表示附件
name 自定义文档名,若不填则默认使用上传的附件名
downloadable 1 是否允许下载:0表示不能下载,1表示允许下载
state 腾讯云直传-获取资源签名接口中object.state

SDK封装方法使用示例:

$options = [
    'name' => '附件名'
    'downloadable' => 0 // 是否可下载
];
$Lxapi = new \Lexiangla\Openapi\Api(AppKey, AppSecret);
$file_path =  '/path/to/测试.xlsx'; // 文件的绝对路径
$response = $Lxapi->uploadAttachment($staff_id, $file_path, $options);

响应document

201 Created 状态码
{
  "data": {
      "type":"attachment",
      "id":"cd2a641a60ee11e9b2185254009b5a66",
      "attributes": {
          "name":"测试.xlsx"
       }
   }
}

获取单个附件

此接口适用于通过查看文档等接口获取到attachment资源的id后,调用此接口查看附件详情。

接口调用说明:

GET https://lxapi.lexiangla.com/cgi-bin/v1/attachments/{AttachmentID}

参数说明:

参数 是否必须 默认值 说明
AttachmentID 对象类型为attachment的资源对象ID,即附件ID

SDK封装方法使用示例:

$Lxapi = new \Lexiangla\Openapi\Api(AppKey, AppSecret);
$response = $Lxapi->get('attachments/4a136db20b4511eabe0b10e7c61c70fc');

响应document

200 OK 状态码
{
    "data":{
        "type":"attachment",
        "id":"4a136db20b4511eabe0b10e7c61c70fc",
        "attributes":{
            "name":"2098642.png",
            "downloadable":1
        },
        "links":{
            "download":"https://file.lexiang-asset.com/xxxxx/attachments/2019/11/4983d116-0b45-11ea-8b68-10e7c61c70fc.png?hc=6d59851821bb3f460c79e13ef4505372&sign=xxxxx"
        }
    }
}