3vjia Technology MOS API

MOS系统

Operations 35

POST /api/v1/manufacturing/confirmDisOrder 订单拆单确认接口 #
POST /api/v1/manufacturing/createOrderBatch 生成批次接口 #
POST /api/v1/manufacturing/getBatchOrderList 获取已生成批次订单列表接口 #
POST /api/v1/manufacturing/getBatchProductionXml 获取批次拆单XML接口 #
POST /api/v1/manufacturing/getFactorySupplementOrderListByPage 获取工厂补单列表接口 #
POST /api/v1/manufacturing/getManufacturingOrderPartList 获取订单部件列表接口 #
POST /api/v1/manufacturing/getOrder 获取订单信息接口 #
POST /api/v1/manufacturing/getOrder3dFileUrl 获取订单3D文件地址接口 #
POST /api/v1/manufacturing/getOrderAttachment 获取订单附件接口 #
POST /api/v1/manufacturing/getOrderCadFile 获取订单CAD文件接口 #
POST /api/v1/manufacturing/getOrderCadFileList 获取订单CAD文件列表接口 #
POST /api/v1/manufacturing/getOrderCommunicationRecord 获取订单交流记录接口 #
POST /api/v1/manufacturing/getOrderOperationTrace 获取订单跟进记录接口 #
POST /api/v1/manufacturing/getOrderPayRecord 获取订单付款记录接口 #
POST /api/v1/manufacturing/getOrderQuoteXml 获取订单报价XML接口 #
POST /api/v1/manufacturing/getOrderSchemeHistory 获取订单历史方案记录接口 #
POST /api/v1/manufacturing/getOrderStateDictionary 获取订单状态字典接口 #
POST /api/v1/manufacturing/getOrderThreeViewDrawingFile 获取订单三视图文件接口 #
POST /api/v1/manufacturing/getOuterProductionXml 获取第三方生产软件XML接口 #
POST /api/v1/manufacturing/getPlatformOrderListByPage 获取工厂订单列表接口 #
POST /api/v1/manufacturing/getShopOrderListByPage 获取门店订单列表接口 #
POST /api/v1/manufacturing/getSupplementOrder 获取补单详情接口 #
POST /api/v1/manufacturing/queryCreateOrderBatchResult 获取批次生成结果接口 #
POST /api/v1/manufacturing/signOrder 工厂签收订单接口 #
POST /api/v1/manufacturing/submitAndSignOrder 门店提交订单工厂自动签收接口 #
POST /api/v1/manufacturing/submitOrder 门店提交订单接口 #
POST /api/v1/manufacturing/updateDiyOrderNo 修改自定义订单号接口 #
POST /api/v1/manufacturing/updateOfferTime 修改生产交货时间接口 #
POST /api/v1/manufacturing/updateOrderState 变更订单状态接口 #
POST /api/v1/manufacturingOrder/getProductionXml 获取订单拆单XML接口 #
POST /api/v1/platformorders/assignCheckerForOpen 批量分配审单员 #
POST /api/v1/platformorders/batchExecuteOperationForOpen 批量执行订单操作 #
POST /api/v1/quotation/queryQuoteOrderResult 获取订单报价计算结果接口 #
POST /api/v1/quotation/quoteOrder 提交订单报价计算任务接口 #
POST /api/v1/shoporders/createReplenishOrderForOpen 创建售后单和补单 #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/3vjia-technology-mos-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

3vjia-technology-mos-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: 3vjia Open Platform MOS API
  version: '2026-09-05'
  summary: Home-furnishing 3D cloud design, quotation, order, manufacturing (AIMES/MOS/DMS) and AI operations exposed by the 3vjia (三维家) Open Platform.
  description: Machine-readable description of the 3vjia (三维家 / AiHouse) Open Platform, DERIVED — not published by the provider in this form.
  contact:
    name: 3vjia Open Platform
    url: https://dev.3vjia.com/
servers:
- url: https://open-gateway.3vjia.com
  description: 3vjia Open Platform gateway (current)
- url: https://open.3vjia.com
  description: Legacy open gateway — takes ?sysCode=external&access_token=
security:
- oauth2ClientCredentials: []
tags:
- name: MOS
  description: MOS系统
paths:
  /api/v1/manufacturing/confirmDisOrder:
    post:
      operationId: apiV1ManufacturingConfirmDisOrder
      summary: 订单拆单确认接口
      tags:
      - MOS
      x-source-documentation: https://dev.3vjia.com/document?apiId=474669617277665340
      x-documentation-category: MOS系统 / 订单管理
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                orderNo:
                  type: string
                  description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效
                  examples:
                  - 63CG19120402
                orderRecordId:
                  type: string
                  description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo
                  examples:
                  - F053521B72F34613BEAD2CC8B6279E75
                outUserId:
                  type: string
                  description: 操作人-企业账号绑定时使用的企业用户ID,userId、userName、outUserId三个中,outUserId优先级第三
                  examples:
                  - '123456'
                userId:
                  type: string
                  description: 操作人-三维家用户ID,userId、userName、outUserId三个中,userId优先级最高
                  examples:
                  - '1000122456'
                userName:
                  type: string
                  description: 操作人-三维家账号,userId、userName、outUserId三个中,userName优先级第二
                  examples:
                  - 3vj123456
            example:
              orderNo: 63CG19120402
              outUserId: '123456'
              userName: 3vj123456
              userId: '1000122456'
              orderRecordId: F053521B72F34613BEAD2CC8B6279E75
      responses:
        '200':
          description: 成功 / OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: 请求是否成功 / whether the call succeeded
                  code:
                    type: integer
                    description: 结果码 / result code (0 = success)
                  msg:
                    type: string
                    description: 提示信息 / message
                  data:
                    type: object
              example:
                msg: 成功
                code: 0
                data: true
                success: true
        '401':
          description: access_token 缺失或已过期 / missing or expired access_token
  /api/v1/manufacturing/createOrderBatch:
    post:
      operationId: apiV1ManufacturingCreateOrderBatch
      summary: 生成批次接口
      tags:
      - MOS
      x-source-documentation: https://dev.3vjia.com/document?apiId=474672016889319474
      x-documentation-category: MOS系统 / 生产批次
      description: 指定订单进行生成批次
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                operatorOutUserId:
                  type: string
                  description: 操作生成批次的企业系统用户ID(需绑定过三维家账号),operatorUserId、operatorUserName、operatorOutUserId三项至少传一项,当operatorUserId、operatorUserName为空时,operatorOutUserId有效
                operatorUserId:
                  type: string
                  description: 操作生成批次的三维家用户ID,operatorUserId、operatorUserName、operatorOutUserId三项至少传一项,若传了operatorUserId,当忽略operatorUserName、operatorOutUserId字段
                operatorUserName:
                  type: string
                  description: 操作生成批次的三维家账号,operatorUserId、operatorUserName、operatorOutUserId三项至少传一项,当operatorUserId为空时,operatorUserName有效,传了operatorUserName将忽略operatorOutUserId字段
                orderNoList:
                  type: array
                  items: {}
                  description: 要生成批次的订单号列表,外协订单无法使用此字段,orderRecordIdList和orderNoList至少传一项,当orderRecordIdList为空时,此字段有效
                orderRecordIdList:
                  type: array
                  items: {}
                  description: 要生成批次的订单ID列表,orderRecordIdList和orderNoList至少传一项,当orderRecordIdList有值时会忽略orderNoList
            example:
              operatorOutUserId: ''
              operatorUserId: ''
              orderRecordIdList: []
              operatorUserName: ''
              orderNoList: []
      responses:
        '200':
          description: 成功 / OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: 请求是否成功 / whether the call succeeded
                  code:
                    type: integer
                    description: 结果码 / result code (0 = success)
                  msg:
                    type: string
                    description: 提示信息 / message
                  data:
                    type: object
              example:
                msg: 成功
                code: 0
                data: xxx
                success: true
        '401':
          description: access_token 缺失或已过期 / missing or expired access_token
  /api/v1/manufacturing/getBatchOrderList:
    post:
      operationId: apiV1ManufacturingGetBatchOrderList
      summary: 获取已生成批次订单列表接口
      tags:
      - MOS
      x-source-documentation: https://dev.3vjia.com/document?apiId=475027993060782088
      x-documentation-category: MOS系统 / 生产批次
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                batchNo:
                  type: string
                  description: 批次号,batchNo和createBatchBeginTime不能同时为空
                  examples:
                  - 63-191210-235
                createBatchBeginTime:
                  type: string
                  description: 创建批次开始时间,格式yyyy-MM-ddHH:mm:ss,createBatchBeginTime和batchNo不能同时为空,createBatchBeginTime和createBatchEndTime时间差不能超过7天
                  examples:
                  - '2020-05-01 00:00:00'
                createBatchEndTime:
                  type: string
                  description: 创建批次结束时间,格式yyyy-MM-ddHH:mm:ss,当createBatchBeginTime有值时,有默认值为当前时间
                  examples:
                  - '2020-05-07 00:00:00'
            example:
              batchNo: 63-191210-235
              createBatchEndTime: '2020-05-07 00:00:00'
              createBatchBeginTime: '2020-05-01 00:00:00'
      responses:
        '200':
          description: 成功 / OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: 请求是否成功 / whether the call succeeded
                  code:
                    type: integer
                    description: 结果码 / result code (0 = success)
                  msg:
                    type: string
                    description: 提示信息 / message
                  data:
                    type: object
                    properties:
                      batchDate:
                        type: string
                        description: 生成批次的时间,格式yyyy-MM-ddHH:mm:ss
                      batchNo:
                        type: string
                        description: 批次号
                      consigneeAddress:
                        type: string
                        description: 收货地址
                      contactName:
                        type: string
                        description: 联系人
                      contactWay:
                        type: string
                        description: 联系方式
                      createBatchUser:
                        type: object
                        properties:
                          avatar:
                            type: string
                            description: 设计师头像
                          mobile:
                            type: string
                            description: 手机号码
                          name:
                            type: string
                            description: 姓名
                          nickName:
                            type: string
                            description: 昵称
                          outUserId:
                            type: string
                            description: 账号绑定的企业系统用户ID
                          userId:
                            type: string
                            description: 三维家用户ID
                          userName:
                            type: string
                            description: 三维家账号
                        description: 操作用户
                      customer:
                        type: object
                        properties:
                          customerAddress:
                            type: string
                            description: 客户地址
                          customerCode:
                            type: string
                            description: 客户编码
                          customerId:
                            type: string
                            description: 客户ID
                          customerMobile:
                            type: string
                            description: 客户手机
                          customerName:
                            type: string
                            description: 客户名称
                        description: 客户信息
                      deliveryDate:
                        type: string
                        description: 发货日期,格式yyyy-MM-dd
                      diyOrderNo:
                        type: string
                        description: 自定义订单号
                      factoryOrgan:
                        type: object
                        properties:
                          organId:
                            type: string
                            description: 企业ID
                          organName:
                            type: string
                            description: 企业名称
                        description: 部门所属机构信息
                      mainColor:
                        type: string
                        description: 主材颜色
                      orderName:
                        type: string
                        description: 订单名称
                      orderNo:
                        type: string
                        description: 订单号
                      orderRecordId:
                        type: string
                        description: 订单ID
                      orderType:
                        type: string
                        description: 订单类型(衣柜、橱柜、系统柜...)
                      orderVersion:
                        type: string
                        description: 订单版本号
                      partVersion:
                        type: string
                        description: 拆单版本号
                      remark:
                        type: string
                        description: 备注
                      shopDept:
                        type: object
                        properties:
                          customerCode:
                            type: string
                            description: 部门对应客户部门编码
                          deptId:
                            type: string
                            description: 部门ID
                          deptName:
                            type: string
                            description: 部门名称
                          outDeptId:
                            type: string
                            description: 部门所绑定企业系统部门ID,绑定过才有值
                          storeType:
                            type: integer
                            format: int32
                            description: 类型0=门店,1=部门
                        description: 上级部门信息
                      shopOrgan:
                        type: object
                        properties:
                          organId:
                            type: string
                            description: 企业ID
                          organName:
                            type: string
                            description: 企业名称
                        description: 部门所属机构信息
              example:
                msg: ''
                code: 0
                data:
                - orderType: ''
                  batchNo: ''
                  shopOrgan:
                    organName: ''
                    organId: ''
                  orderNo: ''
                  contactName: ''
                  batchDate: ''
                  remark: ''
                  orderVersion: ''
                  factoryOrgan:
                    organName: ''
                    organId: ''
                  diyOrderNo: ''
                  orderRecordId: ''
                  partVersion: ''
                  mainColor: ''
                  shopDept:
                    deptName: ''
                    storeType: 0
                    deptId: ''
                    customerCode: ''
                    outDeptId: ''
                  contactWay: ''
                  deliveryDate: ''
                  createBatchUser:
                    nickName: ''
                    mobile: ''
                    avatar: ''
                    outUserId: ''
                    userName: ''
                    userId: ''
                    name: ''
                  consigneeAddress: ''
                  customer:
                    customerAddress: ''
                    customerCode: ''
                    customerName: ''
                    customerId: ''
                    customerMobile: ''
                  orderName: ''
                success: false
        '401':
          description: access_token 缺失或已过期 / missing or expired access_token
  /api/v1/manufacturing/getBatchProductionXml:
    post:
      operationId: apiV1ManufacturingGetBatchProductionXml
      summary: 获取批次拆单XML接口
      tags:
      - MOS
      x-source-documentation: https://dev.3vjia.com/document?apiId=475021823252181021
      x-documentation-category: MOS系统 / 生产批次
      description: 获取批次拆单XML
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                batchNo:
                  type: string
                  description: 批次号
                  examples:
                  - 22-161013-01
            example:
              batchNo: 22-161013-01
      responses:
        '200':
          description: 成功 / OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: 请求是否成功 / whether the call succeeded
                  code:
                    type: integer
                    description: 结果码 / result code (0 = success)
                  msg:
                    type: string
                    description: 提示信息 / message
                  data:
                    type: object
                    properties:
                      batchNo:
                        type: string
                        description: 批次号
                      batchXmlContent:
                        type: string
                        description: 批次拆单xml的Base64字符串
                      createTime:
                        type: string
                        description: 创建批次时间,格式yyyy-MM-ddHH:mm:ss
                      createUser:
                        type: object
                        properties:
                          avatar:
                            type: string
                            description: 设计师头像
                          mobile:
                            type: string
                            description: 手机号码
                          name:
                            type: string
                            description: 姓名
                          nickName:
                            type: string
                            description: 昵称
                          outUserId:
                            type: string
                            description: 账号绑定的企业系统用户ID
                          userId:
                            type: string
                            description: 三维家用户ID
                          userName:
                            type: string
                            description: 三维家账号
                        description: 操作用户
                      orderList:
                        type: array
                        items:
                          type: object
                          properties:
                            diyOrderNo:
                              type: string
                              description: 自定义订单号
                            orderName:
                              type: string
                              description: 订单名称
                            orderNo:
                              type: string
                              description: 订单编号
                            orderRecordId:
                              type: string
                              description: 订单的通用ID,同一订单下店铺订单、工厂订单此值是相同的
                        description: 通用的生产订单结构
                      recordId:
                        type: string
                        description: 批次ID
              example:
                msg: ''
                code: 0
                data:
                  batchNo: ''
                  orderList:
                  - orderNo: ''
                    diyOrderNo: ''
                    orderRecordId: ''
                    orderName: ''
                  batchXmlContent: ''
                  recordId: ''
                  createTime: ''
                  createUser:
                    nickName: ''
                    mobile: ''
                    avatar: ''
                    outUserId: ''
                    userName: ''
                    userId: ''
                    name: ''
                success: false
        '401':
          description: access_token 缺失或已过期 / missing or expired access_token
  /api/v1/manufacturing/getFactorySupplementOrderListByPage:
    post:
      operationId: apiV1ManufacturingGetFactorySupplementOrderListByPage
      summary: 获取工厂补单列表接口
      tags:
      - MOS
      x-source-documentation: https://dev.3vjia.com/document?apiId=475006971230105648
      x-documentation-category: MOS系统 / 订单数据
      description: 分页获取门店补单列表
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                createBeginTime:
                  type: string
                  description: 订单创建开始时间,格式yyyy-MM-ddHH:mm:ss
                createEndTime:
                  type: string
                  description: 订单创建结束时间,格式yyyy-MM-ddHH:mm:ss,当createBeginTime有值时,此值有默认值为当前时间
                customerInfo:
                  type: string
                  description: 客户信息
                orderNo:
                  type: string
                  description: 补单号
                pageIndex:
                  type: integer
                  format: int32
                  description: 页码,最小值为1,默认值为1
                pageSize:
                  type: integer
                  format: int32
                  description: 分页大小,最小值1,最大值500,默认值50
            example:
              createBeginTime: ''
              orderNo: ''
              customerInfo: ''
              pageSize: 0
              pageIndex: 0
              createEndTime: ''
      responses:
        '200':
          description: 成功 / OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: 请求是否成功 / whether the call succeeded
                  code:
                    type: integer
                    description: 结果码 / result code (0 = success)
                  msg:
                    type: string
                    description: 提示信息 / message
                  data:
                    type: object
                    properties:
                      pageIndex:
                        type: integer
                        format: int32
                      pageSize:
                        type: integer
                        format: int32
                      recordCount:
                        type: integer
                        format: int32
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            createTime:
                              type: string
                              description: 订单创建开始时间,格式yyyy-MM-ddHH:mm:ss
                            createUser:
                              type: string
                              description: 创建订单用户
                            factoryStateName:
                              type: string
                              description: 工厂订单状态名称
                            factoryStatus:
                              type: string
                              description: 工厂订单状态值
                            orderName:
                              type: string
                              description: 补单名称
                            orderNo:
                              type: string
                              description: 补单编号
                            recordId:
                              type: string
                              description: 补单ID
                            shopStateName:
                              type: string
                              description: 门店订单状态名称
                            shopStatus:
                              type: string
                              description: 门店订单状态值
                        description: 获取补单信息返参
              example:
                msg: ''
                code: 0
                data:
                  recordCount: 0
                  pageSize: 0
                  result:
                  - orderNo: ''
                    factoryStateName: ''
                    shopStateName: ''
                    factoryStatus: ''
                    recordId: ''
                    shopStatus: ''
                    createTime: ''
                    createUser: ''
                    orderName: ''
                  pageIndex: 0
                success: false
        '401':
          description: access_token 缺失或已过期 / missing or expired access_token
  /api/v1/manufacturing/getManufacturingOrderPartList:
    post:
      operationId: apiV1ManufacturingGetManufacturingOrderPartList
      summary: 获取订单部件列表接口
      tags:
      - MOS
      x-source-documentation: https://dev.3vjia.com/document?apiId=474672016889319472
      x-documentation-category: MOS系统 / 订单数据
      description: 获取订单部件列表,可以按照订单ID、订单号
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                orderNo:
                  type: string
                  description: 订单号,订单ID、订单号至少传1项,当orderRecordId为空时,orderNo有效,外协订单无法使用orderNo查询
                  examples:
                  - 63CG19120402
                orderRecordId:
                  type: string
                  description: 订单ID,店铺订单、工厂订单通用,同一订单的店铺订单、工厂订单的ID一致,订单ID、订单号至少传1项,当orderRecordId不为空时,将忽略orderNo
                  examples:
                  - F053521B72F34613BEAD2CC8B6279E75
            example:
              orderNo: 63CG19120402
              orderRecordId: F053521B72F34613BEAD2CC8B6279E75
      responses:
        '200':
          description: 成功 / OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: 请求是否成功 / whether the call succeeded
                  code:
                    type: integer
                    description: 结果码 / result code (0 = success)
                  msg:
                    type: string
                    description: 提示信息 / message
                  data:
                    type: object
                    properties:
                      createUser:
                        type: object
                        properties:
                          avatar:
                            type: string
                            description: 设计师头像
                          mobile:
                            type: string
                            description: 手机号码
                          name:
                            type: string
                            description: 姓名
                          nickName:
                            type: string
                            description: 昵称
                          outUserId:
                            type: string
                            description: 账号绑定的企业系统用户ID
                          userId:
                            type: string
                            description: 三维家用户ID
                          userName:
                            type: string
                            description: 三维家账号
                        description: 操作用户
                      diyOrderNo:
                        type: string
                        description: 自定义订单号
                      orderName:
                        type: string
                        description: 订单名称
                      orderNo:
                        type: string
                        description: 订单编号
                      orderPartList:
                        type: array
                        items:
                          type: object
                          properties:
                            actualLength:
                              type: object
                            actualWidth:
                              type: object
                            barcode:
                              type: string
                              description: 条码,板件或门板才有值
                            basicMaterial:
                              type: string
                              description: 板件基材
                            cabinetName:
                              type: string
                              description: 所属柜子名称
                            cabinetNo:
                              type: string
                              description: 柜体编号
                            cabinetPanelNo:
                              type: string
                              description: 部件在柜子内的编号,板件、门板才有值
                            category:
                              type: string
                              description: 部件类型,Board=板件,Door=门板,Metal=五金
                            craftMark:
                              type: string
                              description: 工艺备注
                            doorDirection:
                              type: string
                              description: 门板的开门方向
                            hasHorizontalHole:
                              type: string
                              description: 是否打孔0=不打孔1=打孔
                            isAccurate:
                              type: string
                              description: 是否异形,1=异形0=常规
                            length:
                              type: object
                            material:
                              type: string
                              description: 板件材质
                            num:
                              type: integer
                              format: int32
                              description: 数量,五金才有值
                            partId:
                              type: string
                              description: 部件ID,此字段每次请求时值都可能产生变化,建议每次调接口前先清除订单的历史数据
                            partName:
                              type: string
                              description: 部件名称
                            partNumber:
                              type: string
                              description: 部件编码
                            pkgNo:
                              type: string
                              description: 包号
                            roomName:
                              type: string
                              description: 所属空间名称
                            series:
                              type: string
                              description: 系列
                            spec:
                              type: string
                              description: 规格,五金才有值
                            standardCategory:
                              type: string
                              description: 板件标准生成类型(判别五金安装用)
                            thickness:
                              type: objec

# --- truncated at 32 KB (245 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/3vjia-technology/refs/heads/main/openapi/3vjia-technology-mos-api-openapi.yml