# ali-api-signature

> aliyun api sign RFC3986

Latest version **1.0.2** (published 2018-11-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install ali-api-signature
pnpm add ali-api-signature
yarn add ali-api-signature
bun add ali-api-signature
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-11-05 |
| First published | 2018-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | ming |
| Maintainers | liumingmad |
| Keywords | aliyun api signture |

## Links

- npm: https://www.npmjs.com/package/ali-api-signature
- Repository: https://github.com/liumingmad/aliyun-api-sign
- Homepage: https://github.com/liumingmad/aliyun-api-sign#readme
- Issues: https://github.com/liumingmad/aliyun-api-sign/issues
- npm.io page: https://npm.io/package/ali-api-signature

## Dependencies (3)

- [uuid](https://npm.io/package/uuid.md) ^3.3.2
- [js-base64](https://npm.io/package/js-base64.md) ^2.4.9
- [strict-uri-encode](https://npm.io/package/strict-uri-encode.md) ^2.0.0

## Recent versions

- 1.0.2 (latest) — 2018-11-05
- 1.0.1 — 2018-11-05
- 1.0.0 — 2018-11-03

## README

# aliyun-api-sign
为阿里云api的参数做签名

[阿里云api公共参数](https://help.aliyun.com/document_detail/44432.html?spm=a2c4g.11186623.2.23.519e794eayGWYj)

[签名机制](https://help.aliyun.com/document_detail/44434.html?spm=a2c4g.11186623.2.13.20974bd3lM27eI)

```
import AliApiSign from './lib/sign.js';
const sign = new AliApiSign({
        AccessKeyId: 'accessKeyId',
        AccessKeySecret: 'accessKeySecret',
        SecurityToken: 'securityToken',
        //private params
        Action: 'CreateUploadVideo',
        Title: 'title', 
        FileName: 'nani.mp4'
    });

const url = 'http://vod.cn-shanghai.aliyuncs.com/?' + sign.genParamStr();
console.log(url);

const params = sign.genParam();
console.log(params);
```

```
npm test
```

```
http://vod.cn-shanghai.aliyuncs.com/?AccessKeyId=accessKeyId&Action=CreateUploadVideo&FileName=nani.mp4&Format=json&SecurityToken=securityToken&Signature=wq%2Fbx76g%2FkWAiwumPOQNQNXBxCM%3D&SignatureMethod=Hmac-SHA1&SignatureNonce=9fe0e14a-0b50-48b7-9468-2db4258abf4a&SignatureVersion=1.0&Timestamp=2018-11-03T13%3A33%3A15Z&Title=title&Version=2017-03-21
{ Format: 'json',
  Version: '2017-03-21',
  SignatureMethod: 'Hmac-SHA1',
  SignatureNonce: '9fe0e14a-0b50-48b7-9468-2db4258abf4a',
  SignatureVersion: '1.0',
  Action: 'CreateUploadVideo',
  AccessKeyId: 'accessKeyId',
  AccessKeySecret: 'accessKeySecret',
  Timestamp: '2018-11-03T13:33:15Z',
  SecurityToken: 'securityToken',
  Title: 'title',
  FileName: 'nani.mp4',
  Signature: 'pfuvo+EqSYm8ZIEp2sJDlteS7ho=' }
```

---
_Source: https://npm.io/package/ali-api-signature · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._