CodeBoxCodeBox 文档

文档

API、鉴权、SDK、CLI、Webhook、短链和 AI Agent 接入说明。

概览

  • 开发者指南

    CodeBox 可编程二维码平台 — API、SDK、Webhooks 完整开发者文档

  • 鉴权

    CodeBox API 鉴权方式、权限列表与限流规则

API 接口

  • 生成二维码

    POST /generate - 只需传入 content 即可生成二维码

  • TypeScript SDK

    使用 @codebox.club/sdk 在 Node.js 中快速集成 CodeBox 二维码能力

  • CLI 命令行工具

    使用 @codebox.club/cli 在终端管理二维码、模板和 Webhook,支持 CI/CD 集成和自动化脚本

  • Webhooks

    通过 Webhooks 实时接收二维码扫描、过期等事件通知

  • 动态短链与自有域名

    按设备、地区和微信内外跳转,以及绑定已验证的短链域名

  • 批量操作

    使用 CodeBox API 和 SDK 进行批量二维码生成,了解限制、错误处理和最佳实践

AI Agent 集成

  • MCP Server

    通过 MCP 协议接入 Claude Desktop、Cursor 等 AI Agent,直接调用二维码生成、追踪分析等能力

  • Codex Plugin

    在 Codex 中通过对话创建、修改和分析二维码,内置场景工作流与 CodeBox MCP