YouzanYun SDK

https://github.com/youzan/open-sdk-node
Admin
YouzanYun SDK for Node.js provides a comprehensive interface for accessing the YouzanYun API,...
Tokens:2,904
Snippets:14
Trust Score:9.7
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install YouzanYun SDK

Source: https://context7.com/youzan/open-sdk-node/llms.txt

This snippet shows how to install the YouzanYun SDK for Node.js using npm. It's a prerequisite for using the SDK in your project.

```bash
npm i youzanyun-sdk --save
```

--------------------------------

### Decrypt YouzanYun Push Messages

Source: https://context7.com/youzan/open-sdk-node/llms.txt

Demonstrates how to use the youzanyun-sdk to decrypt incoming encrypted push messages. It includes a basic decryption function and an example of how to integrate it into an Express.js route handler for processing webhooks.

```javascript
const youzanyun = require('youzanyun-sdk');

function decryptMessage(encryptedMessages, clientSecret) {
  try {
    const decrypted = youzanyun.crypto.decrypt(encryptedMessages, clientSecret);
    const data = JSON.parse(decrypted);
    console.log('解密后的消息:', data);
    return data;
  } catch (error) {
    console.error('消息解密失败:', error.message);
  }
}

const express = require('express');
const app = express();

app.post('/webhook/youzan', express.json(), (req, res) => {
  const { msg } = req.body;
  const clientSecret = process.env.YOUZAN_CLIENT_SECRET;

  try {
    const decrypted = youzanyun.crypto.decrypt(msg, clientSecret);
    const data = JSON.parse(decrypted);
    console.log('处理消息类型:', data.type);
    res.json({ code: 0, msg: 'success' });
  } catch (error) {
    res.status(500).json({ code: -1, msg: error.message });
  }
});
```

--------------------------------

### Calling Youzan Cloud APIs with Node.js SDK

Source: https://context7.com/youzan/open-sdk-node/llms.txt

Demonstrates various ways to invoke Youzan Cloud APIs using the Node.js SDK. This includes standard requests, parameter-based requests, rich text content handling, file uploads, and custom host configurations.

```javascript
const youzanyun = require('youzanyun-sdk');
const path = require('path');
const token = 'YOUR_ACCESS_TOKEN';

// Standard API call
async function getShopInfo() {
  const resp = await youzanyun.client.call({
    api: 'youzan.shop.get',
    version: '3.0.0',
    token
  });
  return resp.data;
}

// API call with parameters
async function getTradeDetail(tid) {
  const resp = await youzanyun.client.call({
    api: 'youzan.trade.get',
    version: '4.0.0',
    token,
    params: { tid }
  });
  return resp.data;
}

// Rich text API call
async function callRichTextAPI() {
  const resp = await youzanyun.client.call({
    api: 'youzan.item.update',
    version: '3.0.0',
    token,
    params: { item_id: 123456, desc: '<p>商品描述<strong>富文本</strong></p>' },
    config: { isRichText: true }
  });
  return resp.data;
}

// File upload
async function uploadImage(imagePath) {
  const files = new Map();
  files.set('image', path.resolve(__dirname, imagePath));
  const resp = await youzanyun.client.call({
    api: 'youzan.materials.storage.platform.img.upload',
    version: '3.0.0',
    token,
    files
  });
  return resp.data;
}

// Unauthenticated API call
async function callExemptAPI() {
  const resp = await youzanyun.client.call({
    api: 'youzan.open.api.example',
    version: '1.0.0',
    params: { param1: 'value1' }
  });
  return resp.data;
}
```

--------------------------------

### Manage YouzanYun Access Tokens (Node.js)

Source: https://context7.com/youzan/open-sdk-node/llms.txt

Demonstrates how to manage YouzanYun API access tokens using the SDK. It covers obtaining tokens for self-use applications (silent mode), tool-use applications (authorization_code mode), and refreshing existing tokens (refresh_token mode). Requires client credentials and appropriate authorization codes or refresh tokens.

```javascript
const youzanyun = require('youzanyun-sdk');

// 自用型应用获取 Token（silent 模式）
async function getSilentToken() {
  try {
    const resp = await youzanyun.token.get({
      authorize_type: 'silent',
      client_id: 'YOUR_CLIENT_ID',
      client_secret: 'YOUR_CLIENT_SECRET',
      grant_id: 110,  // 店铺授权ID，必传
      refresh: true,  // 是否获取 refresh_token
    });
    console.log('Token 响应:', resp.data);
    // 响应示例:
    // {
    //   "access_token": "f59b1a6bb04f4e...",
    //   "expires_in": 604800,
    //   "refresh_token": "abc123...",
    //   "scope": "..."
    // }
    return resp.data;
  } catch (error) {
    console.error('获取 Token 失败:', error.message);
  }
}

// 工具型应用获取 Token（authorization_code 模式）
async function getAuthCodeToken() {
  try {
    const resp = await youzanyun.token.get({
      authorize_type: 'authorization_code',
      client_id: 'YOUR_CLIENT_ID',
      client_secret: 'YOUR_CLIENT_SECRET',
      code: 'USER_AUTH_CODE',           // 用户授权后获得的 code
      redirect_uri: 'YOUR_REDIRECT_URI', // 回调地址
    });
    console.log('Token 响应:', resp.data);
    return resp.data;
  } catch (error) {
    console.error('获取 Token 失败:', error.message);
  }
}

// 刷新 Token（refresh_token 模式）
async function refreshAccessToken() {
  try {
    const resp = await youzanyun.token.get({
      authorize_type: 'refresh_token',
      client_id: 'YOUR_CLIENT_ID',
      client_secret: 'YOUR_CLIENT_SECRET',
      refresh_token: 'YOUR_REFRESH_TOKEN',  // 之前获取的 refresh_token
    });
    console.log('刷新后的 Token:', resp.data);
    return resp.data;
  } catch (error) {
    console.error('刷新 Token 失败:', error.message);
  }
}

getSilentToken();

```

--------------------------------

### POST /token/get

Source: https://context7.com/youzan/open-sdk-node/llms.txt

Retrieves or refreshes an access token for YouzanYun API authentication. Supports silent, authorization_code, and refresh_token grant types.

```APIDOC
## POST /token/get

### Description
Retrieves or refreshes an access token for YouzanYun API authentication. This is the primary method for obtaining authorization to call other platform services.

### Method
POST

### Endpoint
https://open.youzanyun.com/token/get

### Parameters
#### Request Body
- **authorize_type** (string) - Required - The grant type: 'silent', 'authorization_code', or 'refresh_token'.
- **client_id** (string) - Required - The application client ID.
- **client_secret** (string) - Required - The application client secret.
- **grant_id** (number) - Optional - Required for 'silent' mode (store authorization ID).
- **code** (string) - Optional - Required for 'authorization_code' mode.
- **refresh_token** (string) - Optional - Required for 'refresh_token' mode.

### Request Example
{
  "authorize_type": "silent",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "grant_id": 110
}

### Response
#### Success Response (200)
- **access_token** (string) - The token used for API calls.
- **expires_in** (number) - Token expiration time in seconds.
- **refresh_token** (string) - Token used to refresh access.

#### Response Example
{
  "access_token": "f59b1a6bb04f4e...",
  "expires_in": 604800,
  "refresh_token": "abc123..."
}
```

--------------------------------

### POST /youzanyun.client.call

Source: https://context7.com/youzan/open-sdk-node/llms.txt

The primary method for executing API calls against the Youzan Cloud platform. It supports various request types including standard, rich text, and file uploads.

```APIDOC
## POST youzanyun.client.call

### Description
Executes a remote API call to the Youzan Cloud platform. Requires the API name and version.

### Method
POST (Internal SDK Method)

### Parameters
#### Request Body
- **api** (string) - Required - The name of the API interface to call.
- **version** (string) - Required - The version of the API.
- **token** (string) - Optional - The access token for authentication.
- **params** (object) - Optional - Key-value pairs for API parameters.
- **files** (Map) - Optional - A Map object for file uploads where key is the field name and value is the file path.
- **config** (object) - Optional - Configuration settings such as { isRichText: boolean }.
- **host** (string) - Optional - Custom API host URL.

### Request Example
{
  "api": "youzan.trade.get",
  "version": "4.0.0",
  "token": "YOUR_ACCESS_TOKEN",
  "params": {
    "tid": "E20190509110527067500013"
  }
}

### Response
#### Success Response (200)
- **code** (number) - Status code.
- **success** (boolean) - Request status.
- **data** (object) - The API response payload.

#### Response Example
{
  "code": 200,
  "success": true,
  "data": {
    "trade": { "tid": "E20190509...", "status": "WAIT_SELLER_SEND_GOODS" }
  }
}
```
Tokens:
Raw