FP 签名
Fynd 平台的签名逻辑
FP-Signature是一个多功能npm软件包,为Fynd平台请求提供签名逻辑. 这个软件包既支持CommonJS模块,也支持ES模块,它也伴随着一个网页捆绑,用于浏览器的直接使用.
安装
您可以通过 npm 安装 FP- 签名 :
npm install @gofynd/fp-signature
如何使用
用于普通JS
const { sign } = require("@gofynd/fp-signature");
ES模块
import { sign } from "@gofynd/fp-signature";
浏览器
<script src="https://cdn.jsdelivr.net/npm/@gofynd/fp-signature@{version}"></script>
<script>
// FP-Signature library will be attached to the global window object
FPSignature.sign();
</script>
在邮递员处方
在邮报上使用FP-Signature作为前言,包括 邮递员 prespect.js 在您 Postman 收藏的前文节中存档.
根据您的要求,在前缀中修改FP-Signature包版本.
职能
sign 函数
这个 sign 函数用于生成签名。 它需要两个参数: request 财务报告和审定财务报表 options。 。 。 .
它会直接返回签名字符串 .
库生成您请求的签名 。 将返回的签名字符串包含在 x-fp-signature 签名请求的页眉 .
说明编号:
x-fp-date时间戳是 所需经费 用于生成签名。 您必须将其包含在请求头或查询参数中 。 这个时间戳有助于防止回放攻击,被用在签名生成过程中. 时间戳应当采用ISO 8601格式,没有冒号,破折号,或毫秒(如:,20240101T120000Z) (中文(简体) ).
type RequestParam = {
method: string;
host?: string;
port?: number;
path?: string;
headers?: any;
body?: any;
doNotEncodePath?: boolean;
doNotModifyHeaders?: boolean;
};
type SigningOptions = {
secret: string;
}
function sign(request : RequestParam, options: SigningOptions) : string {}
RequestParam 对象
这个 RequestParam 对象用于配置需要签名的 HTTP 请求的细节.
属性 :
-
method数字 : (字符串,需要) - 请求的HTTP方法(例如"GET","POST"). -
host数字 : (弦,可选) - 服务器主机 实例:developer.mozilla.org:4097, (中文(简体) ),api.fyndx5.de -
port数字 : (数目,可选) - 服务器的端口号码. -
path数字 : (弦,可选) - 有查询参数的请求 URL 的路径( 如果有的话) . -
headers数字 : (对象,可选) - 请求的自定义信头。 排除常见的默认信头,删除,获取,头,帖,放,补. 说明编号:x-fp-date签名生成需要页眉. -
body数字 : (任何,可选) -请求的内容. -
doNotEncodePath数字 : (boolean,可选) - 如果正确, 路径将不会被编码为 URL . -
doNotModifyHeaders数字 : (boolean,可选) - 如果是真的,在签名时不会修改标题.
示例
const requestToSign = {
method: "GET",
host: "api.fynd.com",
path: "/service/application/configuration/v1.0/application?queryParam=value",
headers: {
Authorization: "Bearer <authorizationToken>",
"x-currency-code": "INR",
"x-fp-date": new Date().toISOString().replace(/[:\-]|\.\d{3}/g, "")
},
};
示例
// For Common JS
// const {sign} = require("@gofynd/fp-signature")
// For ES Module
import {sign} from "@gofynd/fp-signature";
const requestToSign = {
method: "GET",
host: "api.fynd.com",
path: "/service/application/configuration/v1.0/application",
headers: {
Authorization: "Bearer <authorizationToken>",
"x-currency-code": "INR",
"x-fp-date": new Date().toISOString().replace(/[:\-]|\.\d{3}/g, "")
},
};
const signature = sign(requestToSign, { secret: 'your-secret-key' });
// Use the signature as needed - add to headers, query params, etc.
console.log('Generated signature:', signature);