Lemon Squeezy官方JavaScript SDK
介绍
这是Lemon Squeezy的官方JavaScript SDK,让您能轻松地在JavaScript应用中集成计费功能。
特性
- 类型安全:使用TypeScript编写,并用TSDoc文档化。
- 可摇树优化:仅使用您需要的函数。查看包大小。
安装
安装包
# bun
bun install @lemonsqueezy/lemonsqueezy.js
# pnpm
pnpm install @lemonsqueezy/lemonsqueezy.js
# npm
npm install @lemonsqueezy/lemonsqueezy.js
创建API密钥
在Lemon Squeezy仪表板的设置 > API中创建新的API密钥。
将此API密钥添加到您的项目中,例如在.env
文件中作为LEMONSQUEEZY_API_KEY
。
[!注意]
不要直接在浏览器中使用此包,因为这会暴露您的API密钥。这将给任何人完全访问您的Lemon Squeezy账户和商店的API权限。更多信息请参见此处。
在测试模式下使用API
您可以使用测试模式构建和测试与Lemon Squeezy的完整API集成。
在测试模式下创建的任何API密钥都将与您的测试模式商店数据交互。
当您准备好将集成投入生产时,请确保在实时模式下创建API密钥并在生产应用中使用它。
使用方法
import {
getAuthenticatedUser,
lemonSqueezySetup,
} from "@lemonsqueezy/lemonsqueezy.js";
const apiKey = import.meta.env.LEMON_SQUEEZY_API_KEY;
lemonSqueezySetup({
apiKey,
onError: (error) => console.error("错误!", error),
});
const { data, error } = await getAuthenticatedUser();
if (error) {
console.log(error.message);
} else {
console.log(data);
}
更多函数用法,请参见Wiki。
包大小
点击查看
导出 | min+brotli |
---|---|
createDiscount | 991 B |
createCheckout | 895 B |
updateSubscriptionItem | 849 B |
updateSubscription | 841 B |
listWebhooks | 831 B |
listDiscountRedemptions | 821 B |
listLicenseKeyInstances | 820 B |
listSubscriptionInvoices | 818 B |
listLicenseKeys | 817 B |
listOrderItems | 817 B |
listSubscriptionItems | 817 B |
listCheckouts | 814 B |
listDiscounts | 814 B |
listSubscriptions | 814 B |
listUsageRecords | 814 B |
listVariants | 814 B |
listCustomers | 813 B |
listFiles | 813 B |
listOrders | 813 B |
listPrices | 813 B |
listProducts | 813 B |
listStores | 813 B |
updateLicenseKey | 813 B |
createWebhook | 808 B |
updateWebhook | 793 B |
generateSubscriptionInvoice | 789 B |
generateOrderInvoice | 783 B |
activateLicense | 770 B |
validateLicense | 770 B |
deactivateLicense | 764 B |
createUsageRecord | 724 B |
getLicenseKeyInstance | 714 B |
getSubscriptionInvoice | 702 B |
getDiscountRedemption | 700 B |
getSubscriptionItem | 700 B |
getUsageRecord | 700 B |
getOrderItem | 699 B |
getLicenseKey | 698 B |
getOrder | 697 B |
getPrice | 697 B |
getStore | 697 B |
getCheckout | 696 B |
getCustomer | 696 B |
getFile | 696 B |
getProduct | 694 B |
getWebhook | 694 B |
getDiscount | 693 B |
getSubscription | 693 B |
getVariant | 693 B |
updateCustomer | 684 B |
archiveCustomer | 683 B |
createCustomer | 678 B |
cancelSubscription | 660 B |
deleteDiscount | 658 B |
deleteWebhook | 653 B |
getSubscriptionItemCurrentUsage | 651 B |
getAuthenticatedUser | 598 B |
lemonSqueezySetup | 106 B |
贡献
请参阅贡献指南。