Files
kami_frontend/src/api/generated/docs/JDV2TokenManagementApi.md
danial 86a19135a8 feat(token): 新增输入验证码和重新发送验证码接口
- 添加输入验证码接口及请求和响应模型
- 添加重新发送验证码接口及请求和响应模型
- 调整Token相关接口及模型中的字段名tokenName为name
- 更新Token列表接口查询参数tokenName为name,status类型调整为枚举
- 维护API文档,补充新增接口的详细说明和示例
- 更新相关类型定义,完善请求参数接口和响应接口
- 修正部分模型字段名以统一接口字段规范
2025-12-09 18:47:24 +08:00

14 KiB

JDV2TokenManagementApi

All URIs are relative to http://localhost

Method HTTP request Description
apiCardBindingListByTokenGet GET /api/card-binding/list-by-token 查询 Token 绑卡记录
apiTokenCreatePost POST /api/token/create 创建 Token
apiTokenDeletePost POST /api/token/delete 删除 Token
apiTokenGetGet GET /api/token/get 获取 Token 信息
apiTokenInputVerificationCodePost POST /api/token/input-verification-code 输入验证码
apiTokenListGet GET /api/token/list 列出 Token
apiTokenResendVerificationCodePost POST /api/token/resend-verification-code 重新发送验证码
apiTokenUpdatePost POST /api/token/update 修改 Token

apiCardBindingListByTokenGet

KamiApiCamelOilV1ListCardBindingsByTokenRes apiCardBindingListByTokenGet()

Example

import { JDV2TokenManagementApi, Configuration } from './api';

const configuration = new Configuration();
const apiInstance = new JDV2TokenManagementApi(configuration);

let current: number; //页数 (default to undefined)
let pageSize: 5 | 10 | 15 | 20 | 50 | 100; //页码 (default to undefined)
let tokenId: number; //Token ID (default to undefined)

const { status, data } = await apiInstance.apiCardBindingListByTokenGet(
  current,
  pageSize,
  tokenId
);

Parameters

Name Type Description Notes
current [number] 页数 defaults to undefined
pageSize [**5 10 15 20 50 100**]**Array<5 | 10 | 15 | 20 | 50 | 100>** 页码 defaults to undefined
tokenId [number] Token ID defaults to undefined

Return type

KamiApiCamelOilV1ListCardBindingsByTokenRes

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiTokenCreatePost

KamiApiCamelOilV1CreateTokenRes apiTokenCreatePost()

Example

import {
  JDV2TokenManagementApi,
  Configuration,
  KamiApiCamelOilV1CreateTokenReq
} from './api';

const configuration = new Configuration();
const apiInstance = new JDV2TokenManagementApi(configuration);

let kamiApiCamelOilV1CreateTokenReq: KamiApiCamelOilV1CreateTokenReq; // (optional)

const { status, data } = await apiInstance.apiTokenCreatePost(
  kamiApiCamelOilV1CreateTokenReq
);

Parameters

Name Type Description Notes
kamiApiCamelOilV1CreateTokenReq KamiApiCamelOilV1CreateTokenReq

Return type

KamiApiCamelOilV1CreateTokenRes

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiTokenDeletePost

KamiApiCamelOilV1DeleteTokenRes apiTokenDeletePost()

Example

import {
  JDV2TokenManagementApi,
  Configuration,
  KamiApiCamelOilV1DeleteTokenReq
} from './api';

const configuration = new Configuration();
const apiInstance = new JDV2TokenManagementApi(configuration);

let kamiApiCamelOilV1DeleteTokenReq: KamiApiCamelOilV1DeleteTokenReq; // (optional)

const { status, data } = await apiInstance.apiTokenDeletePost(
  kamiApiCamelOilV1DeleteTokenReq
);

Parameters

Name Type Description Notes
kamiApiCamelOilV1DeleteTokenReq KamiApiCamelOilV1DeleteTokenReq

Return type

KamiApiCamelOilV1DeleteTokenRes

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiTokenGetGet

KamiApiCamelOilV1GetTokenRes apiTokenGetGet()

Example

import { JDV2TokenManagementApi, Configuration } from './api';

const configuration = new Configuration();
const apiInstance = new JDV2TokenManagementApi(configuration);

let tokenId: number; //Token ID (default to undefined)

const { status, data } = await apiInstance.apiTokenGetGet(tokenId);

Parameters

Name Type Description Notes
tokenId [number] Token ID defaults to undefined

Return type

KamiApiCamelOilV1GetTokenRes

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiTokenInputVerificationCodePost

KamiApiCamelOilV1InputVerificationCodeRes apiTokenInputVerificationCodePost()

Example

import {
  JDV2TokenManagementApi,
  Configuration,
  KamiApiCamelOilV1InputVerificationCodeReq
} from './api';

const configuration = new Configuration();
const apiInstance = new JDV2TokenManagementApi(configuration);

let kamiApiCamelOilV1InputVerificationCodeReq: KamiApiCamelOilV1InputVerificationCodeReq; // (optional)

const { status, data } = await apiInstance.apiTokenInputVerificationCodePost(
  kamiApiCamelOilV1InputVerificationCodeReq
);

Parameters

Name Type Description Notes
kamiApiCamelOilV1InputVerificationCodeReq KamiApiCamelOilV1InputVerificationCodeReq

Return type

KamiApiCamelOilV1InputVerificationCodeRes

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiTokenListGet

KamiApiCamelOilV1ListTokensRes apiTokenListGet()

Example

import { JDV2TokenManagementApi, Configuration } from './api';

const configuration = new Configuration();
const apiInstance = new JDV2TokenManagementApi(configuration);

let current: number; //页数 (default to undefined)
let pageSize: 5 | 10 | 15 | 20 | 50 | 100; //页码 (default to undefined)
let name: string; //Token名称 (optional) (default to undefined)
let status: 1 | 5 | 2 | 3 | 4 | 0 | 6; //状态 (optional) (default to undefined)

const { status, data } = await apiInstance.apiTokenListGet(
  current,
  pageSize,
  name,
  status
);

Parameters

Name Type Description Notes
current [number] 页数 defaults to undefined
pageSize [**5 10 15 20 50 100**]**Array<5 | 10 | 15 | 20 | 50 | 100>** 页码 defaults to undefined
name [string] Token名称 (optional) defaults to undefined
status [**1 5 2 3 4 0 6**]**Array<1 | 5 | 2 | 3 | 4 | 0 | 6>** 状态 (optional) defaults to undefined

Return type

KamiApiCamelOilV1ListTokensRes

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiTokenResendVerificationCodePost

KamiApiCamelOilV1ResendVerificationCodeRes apiTokenResendVerificationCodePost()

Example

import {
  JDV2TokenManagementApi,
  Configuration,
  KamiApiCamelOilV1ResendVerificationCodeReq
} from './api';

const configuration = new Configuration();
const apiInstance = new JDV2TokenManagementApi(configuration);

let kamiApiCamelOilV1ResendVerificationCodeReq: KamiApiCamelOilV1ResendVerificationCodeReq; // (optional)

const { status, data } = await apiInstance.apiTokenResendVerificationCodePost(
  kamiApiCamelOilV1ResendVerificationCodeReq
);

Parameters

Name Type Description Notes
kamiApiCamelOilV1ResendVerificationCodeReq KamiApiCamelOilV1ResendVerificationCodeReq

Return type

KamiApiCamelOilV1ResendVerificationCodeRes

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiTokenUpdatePost

KamiApiCamelOilV1UpdateTokenRes apiTokenUpdatePost()

Example

import {
  JDV2TokenManagementApi,
  Configuration,
  KamiApiCamelOilV1UpdateTokenReq
} from './api';

const configuration = new Configuration();
const apiInstance = new JDV2TokenManagementApi(configuration);

let kamiApiCamelOilV1UpdateTokenReq: KamiApiCamelOilV1UpdateTokenReq; // (optional)

const { status, data } = await apiInstance.apiTokenUpdatePost(
  kamiApiCamelOilV1UpdateTokenReq
);

Parameters

Name Type Description Notes
kamiApiCamelOilV1UpdateTokenReq KamiApiCamelOilV1UpdateTokenReq

Return type

KamiApiCamelOilV1UpdateTokenRes

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]