@ awakentax/ crypto- tax

对 Awaken 征税 SDK – 将加密税计算链接轻松整合到您的应用程序中.

步骤1:获得 API 密钥

要使用这个SDK,你需要API密钥. 请联系 ưμ㼯a 以获取您的 API 密钥.

安装

npm install @awakentax/crypto-tax

或带线:

yarn add @awakentax/crypto-tax

使用量

初始化 SDK

首先,用您的 API 密钥导入并初始化 SDK :

import { CryptoTaxSDK } from '@awakentax/crypto-tax';

const cryptotax = new CryptoTaxSDK({
  apiKey: 'your-api-key-here'
});

获取链接 URL

通过提供钱包地址创建链接 :

import type { CreateLinkRequest } from '@awakentax/crypto-tax';

const request: CreateLinkRequest = {
  wallets: [
    {
      address: '0x1234567890123456789012345678901234567890',
      name: 'My Main Wallet' // Optional
    },
    {
      address: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd'
    }
  ]
};

const response = await cryptotax.createLink(request);
console.log('Link URL:', response.url);
console.log('Link Code:', response.code);

打开链接

一旦拥有了URL,您可以在浏览器中打开,或者重新定向您的用户:

// In a browser environment
window.location.href = response.url;

// Or open in a new tab/window
window.open(response.url, '_blank');

// In a Node.js environment, you can log it or use a library like 'open'
console.log('Open this URL:', response.url);

完整示例

import { CryptoTaxSDK } from '@awakentax/crypto-tax';
import type { CreateLinkRequest } from '@awakentax/crypto-tax';

async function createTaxLink() {
  // Initialize SDK
  const cryptotax = new CryptoTaxSDK({
    apiKey: process.env.AWAKEN_API_KEY!,
  });

  // Prepare wallet data
  const request: CreateLinkRequest = {
    wallets: [
      {
        address: '0x1234567890123456789012345678901234567890',
        name: 'My Main Wallet'
      }
    ]
  };

  try {
    // Create the link
    const { url, code } = await cryptotax.createLink(request);
    
    // Open the link (browser example)
    window.location.href = url;
    
    // Or redirect users to the tax calculation page
    // window.open(url, '_blank');
  } catch (error) {
    console.error('Failed to create link:', error);
  }
}

看起来像什么

当你打开我们为您生成的URL, 它会看起来像这样。 如果用户没有Awaken账户,它会促使他们创建一个账户,然后为他们自动添加钱包. 如果他们已经有一个账户,它会是一个一点击 添加他们将这些钱包链接到他们现有的Awaken账户.

替代品:使用cURL(不含SDK)

如果您不愿使用SDK,可以使用cURL直接拨打API:

创建伙伴账户链接

curl -X POST https://api.link.awaken.tax/api/links \
  -H "Content-Type: application/json" \
  -H "x-api-key: your-api-key-here" \
  -d '{
    "wallets": [
      {
        "address": "0x1234567890123456789012345678901234567890",
        "name": "My Wallet"
      },
      {
        "address": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd"
      }
    ]
  }'

请求正文 :

• wallets (所需阵列): 钱包对象矩阵
  • address (字符串,要求): 钱包地址
  • name (弦,可选): 钱包名称

回应:

• 成功(201):回归 code 财务报告和审定财务报表 url 对于创建的链接
• 成功 (200): 如果钱包散列已经存在, 返回已有链接
• 错误 (400): 有细节的校验错误
• 错误(404):未找到伙伴关系
• 错误 (500): 内部服务器出错

示例答复:

{
  "code": "abc123xyz",
  "url": "https://awaken.tax/link?code=abc123xyz"
}

API 参考

CryptoTaxSDK

构造器

new CryptoTaxSDK(options: SDKOptions)

选项 :

• apiKey (字符串,要求): 您的 API 键
• baseUrl (字符串,可选):API的基础URL. 默认为 https://api.link.awaken.tax

方法

createLink(request: CreateLinkRequest): Promise<CreateLinkResponse>

创建新的税收计算链接.

参数:

• request.wallets: 钱包对象矩阵 address (必需)和可选 name

回返情况:

• code: 链接的独特代码
• url: 访问税收计算界面的完整 URL