Note:If you encounter errors such as non-existent functions or methods when using the SDK, please update the SDK to the latest version and try again.
SecretId
and SecretKey
.Note:
- For the definition of parameters such as
SecretId
,SecretKey
, andBucket
, see COS’s Glossary.- If you are using cross platform framework such as uni-app, and encounter problems when packaging the app (such as iOS or Android app), use the iOS SDK or Android SDK.
There are two ways to install the SDK for WeChat Mini Programs: manual installation and installation through npm as detailed below.
Copy the cos-wx-sdk-v5.js file in the source code directory to any path in the root directory of your WeChat Mini Program code and reference it using a relative path:
var COS = require('./lib/cos-wx-sdk-v5.js')
If the code of your WeChat Mini Program is packaged using webpack, install the dependencies via npm:
npm install cos-wx-sdk-v5
The WeChat Mini Program code is referenced with var COS = require('cos-wx-sdk-v5');
.
To request COS in your WeChat Mini Program, you need to log in to the WeChat Official Accounts Platform and configure the domain name allowlist by navigating to Development > Development Settings > Server Domain Name. The SDK uses the following two APIs:
For both methods, you need to configure the COS domain name. There are two forms of domain name allowlists.
examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com
ForcePathStyle: true
when instantiating the SDK. In this case, you need to configure the region domain name as the allowed domain name, such as cos.ap-guangzhou.myqcloud.com
.var COS = require('./lib/cos-wx-sdk-v5.js')
var cos = new COS({
// ForcePathStyle: true, // If multiple buckets are used, you can use suffixed requests to reduce the number of allowed domain names to be configured; the region domain name will be used for requests.
getAuthorization: function (options, callback) {
// Get a temporary key asynchronously.
wx.request({
url: 'https://example.com/server/sts.php',
data: {
bucket: options.Bucket,
region: options.Region,
},
dataType: 'json',
success: function (result) {
var data = result.data;
var credentials = data && data.credentials;
if (!data || !credentials) return console.error('credentials invalid');
callback({
TmpSecretId: credentials.tmpSecretId,
TmpSecretKey: credentials.tmpSecretKey,
XCosSecurityToken: credentials.sessionToken,
// We recommend using the time the server receives the credentials as the StartTime, so as to avoid signature error due to time deviations.
StartTime: data.startTime, // Timestamp in seconds, such as 1580000000
ExpiredTime: data.expiredTime, // Timestamp in seconds, such as 1580000900
});
}
});
}
});
// The COS instance can then be used to call a COS request.
// TODO
Create a COS SDK instance in the following methods:
var cos = new COS({
// Required parameter
getAuthorization: function (options, callback) {
// Server examples for JS and PHP: https://github.com/tencentyun/cos-js-sdk-v5/blob/master/server/
// For server-side examples for other programming languages, see the COS SDK for STS: https://github.com/tencentyun/qcloud-cos-sts-sdk
// For the STS documentation, visit https://intl.cloud.tencent.com/document/product/436/14048
wx.request({
url: 'https://example.com/server/sts.php',
data: {
// The required parameters can be obtained from options.
},
success: function (result) {
var data = result.data;
var credentials = data && data.credentials;
if (!data || !credentials) return console.error('credentials invalid');
callback({
TmpSecretId: credentials.tmpSecretId,
TmpSecretKey: credentials.tmpSecretKey,
XCosSecurityToken: credentials.sessionToken,
// We recommend using the time the server receives the credentials as the StartTime, so as to avoid signature error due to time deviations.
StartTime: data.startTime, // Timestamp in seconds, such as 1580000000
ExpiredTime: data.expiredTime, // Timestamp in seconds, such as 1580000900
});
}
});
}
});
Note:For more information about how to generate and use a temporary key, see Generating and Using Temporary Keys.
var cos = new COS({
// Required parameter
getAuthorization: function (options, callback) {
// Server example: https://github.com/tencentyun/qcloud-cos-sts-sdk/edit/master/scope.md
wx.request({
url: 'https://example.com/server/sts-scope.php',
data: JSON.stringify(options.Scope),
success: function (result) {
var data = result.data;
var credentials = data && data.credentials;
if (!data || !credentials) return console.error('credentials invalid');
callback({
TmpSecretId: credentials.tmpSecretId,
TmpSecretKey: credentials.tmpSecretKey,
XCosSecurityToken: credentials.sessionToken,
// We recommend using the time the server receives the credentials as the StartTime, so as to avoid signature error due to time deviations.
StartTime: data.startTime, // Timestamp in seconds, such as 1580000000
ExpiredTime: data.expiredTime, // Timestamp in seconds, such as 1580000900
ScopeLimit: true, // Refined permission control needs to be set to true, limiting the key to be reused only for the same request
});
}
});
}
});
Note:For more information about how to generate and use a temporary key, see Generating and Using Temporary Keys.
getAuthorization
before each request, and the backend uses a fixed or temporary key to calculate the signature and returns it to the frontend. This method makes it difficult to control permissions for multipart upload and thus is not recommended.var cos = new COS({
// Required parameter
getAuthorization: function (options, callback) {
// The server obtains a signature. For more information, see the COS SDK for the corresponding programming language: https://intl.cloud.tencent.com/document/product/436/6474?from_cn_redirect=1
// Note: there may be a security risk associated with this method. The backend needs to strictly control permissions through method and pathname, such as prohibiting put /
wx.request({
url: 'https://example.com/server/auth.php',
data: JSON.stringify(options.Scope),
success: function (result) {
var data = result.data;
if (!data || !data.authorization) return console.error('authorization invalid');
callback({
Authorization: data.authorization,
// XCosSecurityToken: data.sessionToken, // If a temporary key is used, sessionToken needs to be passed to XCosSecurityToken
});
}
});
},
});
// Log in to the [CAM console](https://console.intl.cloud.tencent.com/cam/capi) to check and manage the `SecretId` and `SecretKey` of your project.
var cos = new COS({
SecretId: 'SECRETID',
SecretKey: 'SECRETKEY',
});
Parameter | Description | Type | Required |
---|---|---|---|
SecretId | User SecretId | String | No |
SecretKey | User's SecretKey , which we recommend to be used only for frontend debugging and should not be disclosed |
String | No |
FileParallelLimit | Number of concurrent file uploads in the same instance. Default value: 3 | Number | No |
ChunkParallelLimit | Number of concurrent part uploads for the same uploaded file. Default value: 3 | Number | No |
ChunkRetryTimes | Number of retries upon multipart upload/copy failure. Default value: 3 (a request will be made 4 times in total, including the initial one) | Number | No |
ChunkSize | Part size in the multipart upload in bytes. Default value: 1048576 (1 MB) | Number | No |
SliceSize | When files are uploaded in batches using uploadFiles, if the file size is greater than the value of this parameter, multipart upload (sliceUploadFile) is used; otherwise, simple upload (putObject) is used. Default value: 1048576 (1 MB) | Number | No |
CopyChunkParallelLimit | Number of concurrent part uploads for the same multipart copy operation. Default value: 20 | Number | No |
CopyChunkSize | Number of bytes in each part during a multipart copy operation with sliceCopyFile . Default value: 10485760 (10 MB) |
Number | No |
CopySliceSize | When a file is copied using sliceCopyFile, if the file size is greater than the value of this parameter, multipart copy (sliceCopyFile) is used; otherwise, simple copy (putObjectCopy) is used. Default value: 10485760 (10 MB) | Number | No |
ProgressInterval | Callback frequency of the upload progress callback method onProgress in milliseconds. Default value: 1000 |
Number | No |
Protocol | Protocol used when the request is made. Valid values: https: , http: . By default, http: is used when the current page is determined to be in http: format; otherwise, https: is used |
String | No |
ServiceDomain | The request domain name when getService is called, such as service.cos.myqcloud.com |
String | No |
Domain | The custom request domain name used to call a bucket or object API. You can use a template, such as "{Bucket}.cos.{Region}.myqcloud.com" which will use the bucket and region passed in the replacement parameters when an API is called. |
String | No |
UploadQueueSize | The maximum size of the upload queue. Excess tasks will be cleared if their status is not waiting, checking, or uploading. Default value: 10000 | Number | No |
ForcePathStyle | Forces the use of a suffix when sending requests. The suffixed bucket will be placed in the pathname after the domain name, and the bucket will be added to the signature pathname for calculation. Default value: false | Boolean | No |
UploadCheckContentMd5 | Forces the verification of Content-MD5 for file uploads, which calculates the MD5 checksum of the file request body and places it in the Content-MD5 field of the header. Default value: false | Boolean | No |
getAuthorization | Callback method for getting the signature. If there is no SecretId or SecretKey , this parameter is required. **Note: This callback method is passed in during instance initialization, and is only executed to obtain the signature when the instance calls APIs. ** |
Function | No |
UseAccelerate | Whether to enable a global acceleration endpoint. Default value: false . If you set the value to true , you need to enable global acceleration for the bucket. For more information, see Enabling Global Acceleration. |
Boolean | No |
getAuthorization: function(options, callback) { ... }
getAuthorization callback parameter descriptions:
Parameter | Description | Type |
---|---|---|
options | Required for getting the signature | Object |
- Bucket | Bucket name in the format of BucketName-APPID . The bucket name entered here must be in this format |
String |
- Region | Bucket region. For the enumerated values, see Regions and Access Endpoints. | String |
callback | Callback method after the temporary key is obtained | Function |
After the temporary key is obtained, the callback returns an object. The attributes of the returned object are as listed below:
Attribute | Description | Type | Required |
---|---|---|---|
TmpSecretId | tmpSecretId of the obtained temporary key |
String | Yes |
TmpSecretKey | tmpSecretKey of the obtained temporary key |
String | No |
XCosSecurityToken | sessionToken of the obtained temporary key, which corresponds to the x-cos-security-token field in the header |
String | Yes |
StartTime | The timestamp in seconds of when you obtained the key, such as 1580000000 . Passing in this parameter as the signature start time can avoid signature expiration issues due to time deviation on the frontend. |
String | No |
ExpiredTime | expiredTime of the obtained temporary key measured in seconds, i.e., the timeout timestamp, such as 1580000900 |
String | Yes |
getAuthorization: function(options, callback) { ... }
getAuthorization function callback parameter descriptions:
Parameter | Description | Type |
---|---|---|
options | Parameter object for getting the signature | Object |
- Method | Method of the current request | Object |
- Pathname | Request path used for signature calculation | String |
- Key | An object key (object name), the unique identifier of an object in a bucket. For more information, see Object Overview. Note: This parameter is empty if the API that uses the instance is not an object-operation API. |
String |
- Query | Query parameter in the current request. Format: {key: 'val'} | Object |
- Headers | Headers in the current request. Format: {key: 'val'} | Object |
callback | Callback after the temporary key is obtained | Function |
Once the getAuthorization callback function is finished, it returns one of the following:
An Authorization string.
An object whose attributes are listed as follows:
Attribute | Description | Type | Required |
---|---|---|---|
Authorization | Calculated signature string | String | Yes |
XCosSecurityToken | sessionToken of the obtained temporary key, which corresponds to the x-cos-security-token field in the header |
String | No |
There are three ways to get the authentication credentials for your instance by passing in different parameters during instantiation:
SecretId
and SecretKey
, and each time a signature is required, it will be internally calculated by the instance.getAuthorization
callback function, and each time a signature is required, it will be calculated and returned to the instance through this callback.getSTS
callback, and each time a temporary key is required, it will be returned to the instance for signature calculation within the instance during each request.In most cases, you only need to create a COS SDK instance, and use it directly where SDK methods need to be called.
var cos = new COS({
....
});
/* Self-encapsulated upload method */
function myUpload() {
// COS SDK instances do not need to be created in each method
// var cos = new COS({
// ...
// });
cos.putObject({
....
});
}
/* Self-encapsulated deletion method */
function myDelete() {
// COS SDK instances do not need to be created in each method
// var cos = new COS({
// ...
// });
cos.deleteObject({
....
});
}
Below are some examples of common APIs. For more detailed initialization methods, see the examples in the demo.
cos.putBucket({
Bucket: 'examplebucket-1250000000',
Region: 'ap-beijing',
}, function (err, data) {
console.log(err || data);
});
Note:If you need to create a bucket via the WeChat Mini Program, but the bucket name is unknown, you cannot configure the bucket name as an allowed domain name. Instead, you can use suffixed calls. For more information, see FAQs.
cos.getService(function (err, data) {
console.log(data && data.Buckets);
});
The WeChat Mini Program upload API "wx.uploadFile" only supports POST requests. To upload files with the SDK, you need to use the postObject API. If only the file uploading API is needed in your WeChat Mini Program, we do not recommend referencing the SDK. For more information, see the demo.
// First, select the file to get the temporary path
wx.chooseImage({
count: 1, // Default value: 9
sizeType: ['original'], // You can specify whether to use the original or compressed image. The original is used by default value.
sourceType: ['album', 'camera'], // You can specify whether the source is an album or camera. Both are included by default.
success: function (res) {
var filePath = res.tempFiles[0].path;
var filename = filePath.substr(filePath.lastIndexOf('/') + 1);
cos.postObject({
Bucket: 'examplebucket-1250000000',
Region: 'ap-beijing',
Key: 'destination path/' + filename,
FilePath: filePath,
onProgress: function (info) {
console.log(JSON.stringify(info));
}
}, function (err, data) {
console.log(err || data);
});
}
});
cos.getBucket({
Bucket: 'examplebucket-1250000000',
Region: 'ap-beijing',
Prefix: 'exampledir/', // Pass in the file prefixes to be listed here
}, function (err, data) {
console.log(err || data.Contents);
});
Note:This API is used to read object content. To download a file using your browser, you should first get a download URL through the
cos.getObjectUrl
method. For more information, see Pre-signed URLs.
cos.getObject({
Bucket: 'examplebucket-1250000000',
Region: 'ap-beijing',
Key: 'exampleobject.txt',
}, function (err, data) {
console.log(err || data.Body);
});
cos.deleteObject({
Bucket: 'examplebucket-1250000000',
Region: 'ap-beijing',
Key: 'picture.jpg',
}, function (err, data) {
console.log(err || data);
});
Was this page helpful?