Migrate from v1 to the Current Version
The v1 APIs still work but are no longer updated. Both versions use the same OpenAPI Key, so authentication does not change.
Pages marked "Chinese only" do not have an English version yet.
API mapping
| v1 API | Current version | Changes |
|---|---|---|
POST /api/v1/qrcode/read_markdown | POST /api/v2/rpc/qrcodes/getContent | Parameter qrcodeUrl becomes qrcode (coding or full URL); add format: "markdown" |
POST /api/v1/qrcode/read_json | POST /api/v2/rpc/qrcodes/getContent | Same parameters, with format: "json". The response structure differs, so update your parsing to match the new docs |
POST /api/v1/form/get_data | POST /api/v2/rpc/record/getRecords | Filter records with filters; read the field structure from Get form template |
GET /api/v1/getTemplateMeta | POST /api/v2/rpc/templates/get (Chinese only) | Now POST. Parameter templateCode becomes template, which takes the bulk template's coding or full URL, available from the template list (Chinese only) |
GET /api/v1/getQrcodeMsg | POST /api/v2/rpc/templates/getSubcode (Chinese only) | Now POST; pass both template and subcode |
POST /api/v1/certificate/verification | POST /api/v2/rpc/certificates/verify | Use action_type to specify the verification action. The API Key must have write permission |
POST /api/v1/qrcode/get_updates | POST /api/v2/rpc/record/getRecords | Covers form records only. Other dynamic data types, such as status changes, have no replacement yet |
Field definition pages map as follows: Rich Text Module (ContentModule) → QR code content; Form Fields (FormField) → Get form template and Form component types; template components → Template structure (Chinese only); sub-code components (get sub-code content) → Sub-code content (Chinese only).
APIs with no replacement yet
The current version does not offer these APIs yet, so keep calling them as before. They are also listed in the matching groups of the API Reference, marked v1.
| API | Docs |
|---|---|
POST /api/v1/createSubCode | Create sub-code (Chinese only) |
POST /api/v1/editSubCode | Edit sub-code (Chinese only) |
POST /api/v1/deleteSubCode | Delete sub-code (Chinese only) |
POST /api/member/addMember | Add members in bulk (Chinese only) |
POST /api/v1/qrcode/scan_url | Identify a code's source |
If AI will make the calls
For write operations such as creating codes and creating sub-codes in bulk, an AI caller can use Admin MCP directly, with no need for the v1 APIs.