### Get Device List Source: https://context7_llms Retrieves a list of devices. ```APIDOC ## GET /api/devices ### Description Retrieves a list of devices. ### Method GET ### Endpoint /api/devices ### Parameters #### Path Parameters - **None** #### Query Parameters - **shopId** (string) - Optional - Shop ID #### Request Body - **None** ### Request Example { "shopId": "678" } ### Response #### Success Response (200) - **deviceList** (array) - List of devices. ``` -------------------------------- ### GET /rent/cabinet/query Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-67396394 Retrieves information about a specific cabinet device, including its pricing strategy and shop details. ```APIDOC ## GET /rent/cabinet/query ### Description Retrieves information about a specific cabinet device, including its pricing strategy and shop details. ### Method GET ### Endpoint /rent/cabinet/query ### Parameters #### Query Parameters - **deviceId** (string) - Required - Device SN or ID ### Request Example ```json { "deviceId": "BJD60151" } ``` ### Response #### Success Response (200) - **msg** (string) - Message indicating the status of the request. - **code** (integer) - Response code. - **data** (object) - Contains device and pricing information. - **priceStrategy** (object) - Details of the pricing strategy. - **depositAmount** (integer) - Rent a power bank deposit amount. - **priceMinute** (integer) - Price per minute. - **autoRefund** (integer) - Automatic refund indicator. - **timeoutAmount** (integer) - Overdue amount charged. - **timeoutDay** (integer) - Timeout days. - **dailyMaxPrice** (integer) - Maximum daily unit price. - **freeMinutes** (integer) - Free minutes. - **currencySymbol** (string) - Currency symbol. - **price** (number) - Price. - **name** (string) - Name of the pricing strategy. - **currency** (string) - 3 letter currency code. - **shopId** (string) - Shop ID. - **shop** (object) - Details of the shop where the device is located. - **address** (string) - Shop address. - **priceMinute** (string) - Price per minute (as a string). - **city** (string) - City where the shop is located. - **dailyMaxPrice** (integer) - Maximum daily unit price for the shop. - **latitude** (string) - Latitude of the shop location. #### Response Example ```json { "msg": "Success", "code": 0, "data": { "priceStrategy": { "depositAmount": 100, "priceMinute": 1, "autoRefund": 1, "timeoutAmount": 5, "timeoutDay": 1, "dailyMaxPrice": 10, "freeMinutes": 5, "currencySymbol": "¥", "price": 1, "name": "Standard Rental", "currency": "CNY", "shopId": "shop123" }, "shop": { "address": "123 Main St", "priceMinute": "1", "city": "Example City", "dailyMaxPrice": 10, "latitude": "34.0522" } } } ``` ``` -------------------------------- ### GET /cabinet/getAllDevicePage Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-104222005 Retrieves a paginated list of all devices. Supports filtering by page number and number of rows per page. ```APIDOC ## GET /cabinet/getAllDevicePage ### Description Retrieves a paginated list of all devices. Supports filtering by page number and number of rows per page. ### Method GET ### Endpoint /cabinet/getAllDevicePage ### Parameters #### Query Parameters - **limit** (string) - Required - The number of rows per page. - **page** (string) - Required - The current page number. #### Header Parameters - **Authorization** (string) - Optional - Authentication token. ### Request Example ```json { "limit": "20", "page": "1" } ``` ### Response #### Success Response (200) - The response will be a JSON object containing device information. Specific schema details are not provided in the OpenAPI spec. #### Response Example ```json { "example": "response body" } ``` #### Error Responses - **401** Unauthorized - **403** Forbidden - **404** Not Found ``` -------------------------------- ### Define Shop List GET Endpoint in OpenAPI Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-104222039 This YAML snippet defines a GET endpoint to retrieve a list of shops in an OpenAPI 3.0.1 specification. It includes path details, summary, description, operation ID, tags, and an optional Authorization header parameter. The response schema includes properties for message, code, and an array of shop data. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /shop/getShopList: get: summary: get all shop list deprecated: false description: get all shop list operationId: getShopListUsingGET tags: - Advance API/Shop - shop-controller parameters: - name: Authorization in: header description: '' required: false example: Basic dGVzdDp0ZXN0 schema: type: string responses: '200': description: '' content: application/json: schema: type: object properties: msg: type: string code: type: string data: type: array items: type: object properties: id: type: integer ids: type: integer newID: type: string description: Merchant Unique Identifier pPtid: type: string description: Platform ID pSfid: type: string pCsid: type: string pQyid: type: string pYwid: type: string pDpid: type: string shopName: type: string description: merchant name shopAddress: type: string description: Merchant Address shopAddress1: type: string description: Merchant Address mobile: type: string description: Mobile distance: type: string description: Distance batteryNum: type: string description: Number of merchant batteries freeNum: type: string description: The number of batteries that merchants can borrow cabinetNum: type: integer description: Number of merchant cabinets longitude: type: string description: longitude latitude: type: string description: latitude shopBanner: type: string description: Merchant banner shopIcon: type: string description: Merchant icon shopTime: type: string description: Business hours of the merchant shopWorkTime: type: array items: type: object properties: openTime: type: string description: Business opening time closeTime: type: string description: Closing time for merchants dayOfWeek: type: integer description: >- The day of the week on which it occurs every week x-apifox-orders: - openTime - closeTime - dayOfWeek description: List of business hours for merchants shopUrl: type: string description: The image address of the merchant's homepage distanceNumber: type: integer description: distance sceneType: type: string description: Merchant scenario type sceneTypeDesc: type: string ``` -------------------------------- ### GET /shop Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-104222039 Retrieves a list of shops with various details. Supports filtering and pagination. ```APIDOC ## GET /shop ### Description Retrieves a list of shops with various details. Supports filtering and pagination. ### Method GET ### Endpoint /shop ### Parameters #### Query Parameters - **pageNo** (integer) - Optional - The page number for pagination. - **pageSize** (integer) - Optional - The number of items per page. - **businessType** (string) - Optional - Filters shops by business type. - **businessScene** (string) - Optional - Filters shops by business scene. - **businessCategory** (string) - Optional - Filters shops by business category. - **shopName** (string) - Optional - Filters shops by shop name. - **shopAddress** (string) - Optional - Filters shops by shop address. - **infoStatus** (string) - Optional - Filters shops by information status. - **pPriceid** (integer) - Optional - Filters shops by price ID. - **posPriceId** (integer) - Optional - Filters shops by POS price ID. - **businessStatus** (integer) - Optional - Filters shops by business status. ### Request Example ``` GET /shop?pageNo=1&pageSize=10&shopName=ExampleShop ``` ### Response #### Success Response (200) - **msg** (string) - An empty string indicating success. - **code** (integer) - The status code, expected to be 0 for success. - **data** (array) - An array of shop objects, each containing detailed information such as: - **id** (integer) - Unique identifier for the shop. - **newID** (string) - New ID for the shop. - **shopName** (string) - Name of the shop. - **shopAddress** (string) - Address of the shop. - **mobile** (string) - Mobile number associated with the shop. - **distance** (string) - Distance to the shop. - **batteryNum** (string) - Number of batteries available. - **freeNum** (string) - Number of free units. - **cabinetNum** (integer) - Number of cabinets. - **longitude** (string) - Longitude coordinate. - **latitude** (string) - Latitude coordinate. - **shopBanner** (string) - URL for the shop banner image. - **shopIcon** (string) - URL for the shop icon. - **shopTime** (string) - Operating hours description. - **shopUrl** (string) - URL for the shop. - **distanceNumber** (integer) - Numerical distance. - **sceneType** (string) - Type of business scene. - **sceneTypeDesc** (string) - Description of the business scene type. - **pStoreType** (string) - Type of store. - **pStoreCategory** (string) - Category of store. - **infoStatus** (string) - Information status. - **pPriceid** (integer) - Price ID. - **posPriceId** (integer) - POS price ID. - **pMian** (string) - Main product or service. - **pJifei** (string) - Fee details. - **pJifeiDanwei** (string) - Fee unit. - **priceUnit** (integer) - Price unit. - **pFengding** (string) - Cap or limit. - **pYajin** (string) - Deposit amount. - **overtimeAmount** (string) - Overtime charge amount. - **overtimeDay** (integer) - Overtime duration in days. - **pCurrency** (string) - Currency code. - **currencyName** (string) - Currency name. - **canReturnNum** (string) - Number of items that can be returned. - **chargingBatteryNum** (string) - Number of charging batteries. - **shopType** (array) - Array of shop types. - **cabinetIds** (string) - IDs of cabinets. - **businessType** (string) - Business type. - **businessTypeDesc** (string) - Description of business type. - **businessScene** (string) - Business scene. - **businessSceneDesc** (string) - Description of business scene. - **businessCategory** (string) - Business category. - **businessCategoryDesc** (string) - Description of business category. - **businessStatus** (integer) - Business status. - **extendedJson** (string) - Extended JSON data. #### Response Example ```json { "msg": "", "code": 0, "data": [ { "id": 1, "ids": 0, "newID": "SHOP123", "pPtid": "PTID456", "pSfid": "SFID789", "pCsid": "CSID012", "pQyid": "QYID345", "pYwid": "YWID678", "pDpid": "DPID901", "shopName": "Example Tech Store", "shopAddress": "123 Innovation Street", "shopAddress1": "Suite 100", "mobile": "+1-555-123-4567", "distance": "0.5 km", "batteryNum": "50", "freeNum": "10", "cabinetNum": 5, "longitude": "-74.0060", "latitude": "40.7128", "shopBanner": "https://example.com/banners/shop123.jpg", "shopIcon": "https://example.com/icons/shop123.png", "shopTime": "Mon-Fri: 9am-6pm", "shopWorkTime": [ { "openTime": "09:00", "closeTime": "18:00", "dayOfWeek": 1 } ], "shopUrl": "https://example.com/shops/123", "distanceNumber": 500, "sceneType": "Retail", "sceneTypeDesc": "Retail Store", "pStoreType": "Electronics", "pStoreCategory": "Gadgets", "infoStatus": "Active", "pPriceid": 101, "posPriceId": 202, "pMian": "Latest Gadgets", "pJifei": "$5/day", "pJifeiDanwei": "day", "priceUnit": 1, "pFengding": "$50", "pYajin": "$100", "overtimeAmount": "$2/hour", "overtimeDay": 2, "pCurrency": "USD", "currencyName": "US Dollar", "canReturnNum": "3", "chargingBatteryNum": "20", "shopType": [ 1 ], "cabinetIds": "CAB001,CAB002", "businessType": "Electronics Retail", "businessTypeDesc": "Sales of electronic devices", "businessScene": "Urban Mall", "businessSceneDesc": "Located in a busy city mall", "businessCategory": "Technology", "businessCategoryDesc": "Consumer technology products", "businessStatus": 1, "extendedJson": "{}" } ] } ``` #### Error Responses - **401 Unauthorized**: Indicates missing or invalid authentication credentials. - **403 Forbidden**: Indicates the authenticated user does not have permission to perform the action. - **404 Not Found**: Indicates the requested resource was not found. ``` -------------------------------- ### GET /shop/detail/{shopid} Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-104222038 Retrieves detailed information for a specific shop identified by shopid. Supports optional basic Authorization header. ```APIDOC ## GET /shop/detail/{shopid}\n\n### Description\nRetrieves detailed information for a specific shop.\n\n### Method\nGET\n\n### Endpoint\nhttps://developer.chargenow.top/cdb-open-api/v1/shop/detail/{shopid}\n\n### Parameters\n#### Path Parameters\n- **shopid** (string) - Required - Shop id\n\n#### Query Parameters\n_None_\n\n#### Request Body\n_None_\n\n### Request Example\n_None_\n\n### Response\n#### Success Response (200)\n- **data** (object) - Shop detail object (properties not specified)\n\n#### Response Example\n{\n "example": "response body"\n}\n\n### Error Responses\n- **401 Unauthorized** – Authentication required or failed.\n- **403 Forbidden** – Access denied.\n- **404 Not Found** – Shop not found. ``` -------------------------------- ### GET /devices/{id} Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-104222001 Retrieves detailed information about a specific device. ```APIDOC ## GET /devices/{id} ### Description Retrieves detailed information about a specific device, including its hardware details, current status, location, and operational history. ### Method GET ### Endpoint /devices/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the device to retrieve. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **pCabinetid** (string) - The cabinet ID associated with the device. - **pPort** (string) - The port number the device is connected to. - **pPassword** (string) - The password for device access. - **pTotal** (integer) - Total count of something related to the device. - **pBorrow** (integer) - Number of times the device has been borrowed. - **pAlso** (integer) - Additional count or indicator for the device. - **pRegtime** (string) - The registration time of the device (YYYY-MM-DD HH:MM:SS). - **pStatus** (string) - The current status of the device (e.g., '已授权'). - **authorizationStatusFlag** (integer) - Flag indicating authorization status. - **pLognum** (integer) - Number of login events for the device. - **pLogtime** (string) - The last login time of the device (YYYY-MM-DD HH:MM:SS). - **pJson** (string) - JSON string containing additional device information. - **pShopid** (string) - The shop ID where the device is located. - **pCard** (string) - Card information associated with the device. - **pBorrowtime** (string) - The time the device was last borrowed (YYYY-MM-DD HH:MM:SS). - **pJingdu** (string) - Latitude coordinates of the device. - **pHash** (string) - Hash value related to the device. - **pBomb** (integer) - Bomb counter for the device. - **pCode** (string) - Device code or identifier. - **pZujienum** (integer) - Rental or subscription number. - **pPtid** (string) - Product type ID. - **pPtname** (string) - Product type name. - **pSfid** (string) - Shelf ID. - **pSfname** (string) - Shelf name. - **pCsid** (string) - Cabinet sub-ID. - **pQyid** (string) - Quality ID. - **pYwid** (string) - Service ID. - **pDpid** (string) - Department ID. - **pDpname** (string) - Department name. - **pInfostatus** (string) - Information status of the device (e.g., '在线'). - **infoStatusFlag** (integer) - Flag indicating information status. - **pSignal** (string) - Signal strength of the device. - **pUserip** (string) - The IP address of the user accessing the device. - **pMyip** (string) - The IP address of the device. - **pRemark** (string) - Remarks or notes about the device. - **pPosDeviceid** (string) - Device ID for positioning. - **reportCountJson** (string) - JSON string containing device report counts (e.g., offline times, cancellation times). - **pShopName** (string) - The name of the shop. - **pShopLogo** (string) - URL to the shop's logo. - **fPtUsername** (string) - Username for product type. - **fPtWxPic** (string) - WeChat picture URL for product type. - **fSfUsername** (string) - Username for shelf. - **fSfWxPic** (string) - WeChat picture URL for shelf. - **fDpUsername** (string) - Username for department. - **fDpWxPic** (string) - WeChat picture URL for department. - **pHardwareInfo** (string) - String containing hardware information (e.g., '15080418@@2060@@WIFI@@WIFI'). - **pProductType** (integer) - Product type code. - **pInfoTime** (string) - The time information was last updated (YYYY-MM-DD HH:MM:SS). - **authorizationFailCount** (integer) - Count of authorization failures. - **canNotPopCount** (integer) - Count of times the device could not be popped. - **noThisIdCount** (integer) - Count of events where the ID was not recognized. - **antiTheftSwitchCount** (integer) - Count of anti-theft switch activations. - **idNotRecognizedCount** (integer) - Count of unrecognized ID events. - **switchFailureCount** (integer) - Count of switch failures. - **unableToLockCount** (integer) - Count of times unable to lock. - **lockingCount** (integer) - Count of ongoing locking operations. - **pPositionId** (string) - Positioning ID of the device. #### Response Example ```json { "pCabinetid": "BJH04038", "pPort": "12405", "pPassword": "123456", "pTotal": 12, "pBorrow": 11, "pAlso": 1, "pRegtime": "2023-11-20 15:31:19", "pStatus": "已授权", "authorizationStatusFlag": 0, "pLognum": 52747, "pLogtime": "2024-03-05 10:06:17", "pJson": "{\"T\":\"T\",\"D\":\"BJH04038\",\"R\":\"F\",\"L\":[]}", "pShopid": "7ed1c1f02b", "pCard": "WIFI", "pBorrowtime": "2024-02-04 13:55:59", "pJingdu": "0,0", "pHash": "0,0", "pBomb": 0, "pCode": "1700468359", "pZujienum": 21, "pPtid": "BJCD0000000000000000000000000001", "pPtname": "admins", "pSfid": "234744156861011", "pSfname": "代理提成测试", "pCsid": "", "pQyid": "", "pYwid": "", "pDpid": "234821601900105", "pDpname": "MDGLTY", "pInfostatus": "在线", "infoStatusFlag": 1, "pSignal": "50", "pUserip": "113.89.102.85", "pMyip": "120.77.79.161", "pRemark": " ", "pPosDeviceid": "", "reportCountJson": "{\"sevenOfflineTimes\":3,\"threeCancelOrderTimes\":0,\"threeOfflineTimes\":3,\"sevenCancelOrderTimes\":0,\"oneOfflineTimes\":1,\"oneCancelOrderTimes\":0}", "pShopName": "MDGL", "pShopLogo": "https://saas.dtoolsz.com/uploads/20240228/b529899817424562bd58ebae973305c3.png", "fPtUsername": "admins", "fPtWxPic": "", "fSfUsername": "代理提成测试", "fSfWxPic": "", "fDpUsername": "MDGLTY", "fDpWxPic": "", "pHardwareInfo": "15080418@@2060@@WIFI@@WIFI", "pProductType": 0, "pInfoTime": "2024-01-29 15:46:36", "authorizationFailCount": 0, "canNotPopCount": 0, "noThisIdCount": 0, "antiTheftSwitchCount": 0, "idNotRecognizedCount": 0, "switchFailureCount": 0, "unableToLockCount": 0, "lockingCount": 0, "pPositionId": "0" } ``` #### Error Response (401) Unauthorized #### Error Response (403) Forbidden ``` -------------------------------- ### GET /cabinet/getAllDevice Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-104222004 Queries and retrieves a list of all devices associated with a cabinet. This endpoint allows you to fetch detailed information about each device, including hardware specifications, status, and connectivity details. ```APIDOC ## GET /cabinet/getAllDevice ### Description Queries and retrieves a list of all devices associated with a cabinet. This endpoint allows you to fetch detailed information about each device, including hardware specifications, status, and connectivity details. ### Method GET ### Endpoint /cabinet/getAllDevice ### Parameters #### Header Parameters - **Authorization** (string) - Optional - Authentication token for accessing the API. ### Request Example ```json { "message": "Request sent to query all devices." } ``` ### Response #### Success Response (200) - **msg** (string) - A message indicating the status of the request. - **code** (integer) - The status code of the response. - **data** (array) - An array of device objects, where each object contains the following properties: - **phardwareInfo** (string) - Hardware information (MCU model, firmware version, communication module model, communication module firmware version). - **pId** (integer) - Primary key ID of the device. - **pType** (string) - Type of equipment (e.g., 5/12/24/48 slots). - **pCabinetid** (string) - Device ID. - **pPort** (string) - Communication server port number. - **pTotal** (integer) - Total number of slots (generally consistent with pType). - **pBorrow** (integer) - Rentable quantity. - **pAlso** (integer) - Recoverable quantity. - **pRegtime** (string) - Registration Time. - **pStatus** (string) - Authorization status (1='authorized'; 0='unauthorized'). - **pLognum** (integer) - Number of handshakes (connections with the communication server). - **pLogtime** (string) - Handshake time (last communication time with the communication server). - **pJson** (string) - Communication data (latest communication data). - **pShopid** (string) - Shop ID. - **pCard** (string) - IOT card number. - **pBorrowtime** (string) - Borrow time. - **pJingdu** (string) - Longitude. - **pHash** (string) - Latitude and longitude hash value. - **pBomb** (integer) - Bomb status. - **pCode** (string) - Bound QR code. #### Response Example ```json { "msg": "Success", "code": 0, "data": [ { "phardwareInfo": "MCU_MODEL_123@@V1.0.0@@COM_MODULE_ABC@@V2.1.0", "pId": 101, "pType": "24口设备", "pCabinetid": "CABINET_001", "pPort": "8080", "pTotal": 24, "pBorrow": 20, "pAlso": 4, "pRegtime": "2023-10-27T10:00:00Z", "pStatus": "1", "pLognum": 50, "pLogtime": "2023-10-27T15:30:00Z", "pJson": "{\"status\": \"active\"}", "pShopid": "SHOP_XYZ", "pCard": "IOTCARD_789", "pBorrowtime": "2023-10-27T11:00:00Z", "pJingdu": "34.0522", "pHash": "ABCDEF123456", "pBomb": 0, "pCode": "QRCODE_123" } ] } ``` ``` -------------------------------- ### Get Cabinet and Bayonet Information Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-104222001 Retrieves a list of cabinets and their associated bayonet information, including battery status, operational state, and fault details. ```APIDOC ## GET /api/cabinets/status ### Description Retrieves detailed information about power cabinets and their bayonets. This includes data on battery charge, operational status, fault types, and timestamps. ### Method GET ### Endpoint /api/cabinets/status ### Parameters #### Query Parameters - **cdbSubcabinetPState** (boolean) - Optional - Filter by subcabinet power state. ### Request Example (No request body for GET request) ### Response #### Success Response (200) - **batcabs** (array) - Array of bayonet objects, each containing: - **pId** (integer) - Primary key id - **pSubcabinetid** (string) - Slave device id - **pSubKakou** (integer) - Slave card number - **pCabinetid** (string) - Corresponding host device id - **pKakou** (integer) - Card slogan - **pBatteryid** (string) - Battery id - **pDianliang** (integer) - Battery capacity - **pState** (integer) - Bayonet status (1='returnable', 2='loanable', 3='not affecting lease failure', 5='non-loanable failure') - **pLogtime** (string) - Heartbeat time - **pErrid** (integer) - Number of errors - **pFaultType** (integer) - Fault types (0='normal', 1='battery authorization failed', 2='charging treasure can\'t be ejected from bayonet', 3='No this ID', 4='anti-theft switch', 5='unrecognized ID', 6='insertion switch failed', 7='charging treasure can\'t be locked at bayonet', 8='manual locking') - **pFaultCause** (string) - Failure cause - **pIsGuard** (string) - Anti-theft switch (0='off', 1='on') - **pBatfailTime** (integer) - Number of authorization failures - **pRouterStatus** (integer) - Device availability status (1=available, 2=locked) - **pCheckResult** (string) - Mifi's self-test results - **subcabinetList** (array) - Array of subcabinet objects, each containing: - **pSubcabinetid** (string) - Slave id - **pCabinetid** (string) - Host id - **pSort** (integer) - Sorting number - **pRegtime** (string) - Registration Time - **pState** (string) - Status (0='Online'; 1='Offline') - **pTopicId** (integer) - Color theme id #### Response Example ```json { "batcabs": [ { "pId": 123, "pSubcabinetid": "sub_abc", "pSubKakou": 1, "pCabinetid": "cab_xyz", "pKakou": 1, "pBatteryid": "bat_001", "pDianliang": 85, "pState": 1, "pLogtime": "2023-10-27T10:00:00Z", "pErrid": 0, "pFaultType": 0, "pFaultCause": "", "pIsGuard": "0", "pBatfailTime": 0, "pRouterStatus": 1, "pCheckResult": "OK" } ], "subcabinetList": [ { "pSubcabinetid": "sub_abc", "pCabinetid": "cab_xyz", "pSort": 1, "pRegtime": "2023-10-26T08:00:00Z", "pState": "0", "pTopicId": 1 } ] } ``` ``` -------------------------------- ### GET /cdb-open-api/v1/shops Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-99966818 Retrieves a list of shops including their details, pricing, and cabinet information. The response includes a success status, message, and the shop list. Useful for displaying nearby shops with charging facilities in different scenarios like restaurants, hotels, and more. ```APIDOC ## GET /cdb-open-api/v1/shops ### Description This endpoint fetches a list of shops with associated data such as pricing, cabinets, and detailed shop information including location and scene types. ### Method GET ### Endpoint /cdb-open-api/v1/shops ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example No request body required for GET request. ### Response #### Success Response (200) - **msg** (string) - Response message. - **code** (integer) - Status code, 0 for success. - **list** (array) - Array of shop objects. - **price** (object) - Pricing details. - **cabinet** (object) - Cabinet information. - **shop** (object) - Shop details: - **id** (string) - Required - Shop Id. - **shopName** (string) - Required - Shop name. - **shopAddress** (string) - Required - Shop address. - **mobile** (string) - Required - Mobile number. - **distance** (string) - Required - Distance. - **longitude** (string) - Required - Longitude. - **latitude** (string) - Required - Latitude. - **shopBanner** (string) - Required - Shop Banner. - **shopIcon** (string) - Required - Shop Icon. - **distanceNumber** (number) - Required - Distance Number. - **sceneType** (string) - Required - Merchant scenario types (1: catering, 2: medical, 3: bars, 4: shopping malls, 5: foot baths, 6: hotels, 7: internet cafes, 8: KTV, 9: airports, 10: high-speed rail stations, 11: bus stations, 0: others, default 0). #### Response Example { "msg": "Success", "code": 0, "list": [ { "price": {}, "cabinet": {}, "shop": { "id": "shop123", "shopName": "Example Shop", "shopAddress": "123 Main St", "mobile": "123-456-7890", "distance": "1.5 km", "longitude": "-122.4194", "latitude": "37.7749", "shopBanner": "https://example.com/banner.jpg", "shopIcon": "https://example.com/icon.jpg", "distanceNumber": 1.5, "sceneType": "1" } } ] } ``` -------------------------------- ### GET /rent/order/detail Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-67396392 This endpoint retrieves the detailed information of a rental order based on the trade number. It requires authentication via basic auth and returns comprehensive order data including cabinet, battery, pricing, and status details. The response includes order status, pricing, and timestamps for borrow and return events. ```APIDOC ## GET /rent/order/detail ### Description Retrieves the detail of a rental order using the trade number. This is part of the Open API for managing rental transactions. ### Method GET ### Endpoint /rent/order/detail ### Parameters #### Query Parameters - **tradeNo** (string) - Required - Trade No ### Response #### Success Response (200) - **msg** (string) - Message - **code** (integer) - Response code - **data** (object) - Order details - **cabinetId** (string) - Cabinet ID - **orderId** (string) - Order ID - **batteryId** (string) - Battery ID - **dailyMaxPrice** (integer) - Maximum daily unit price - **freeMinutes** (integer) - Free minutes - **orderAmount** (integer) - Order amount - **borrowTime** (string) - Borrow time - **price** (number) - Price - **currency** (string) - 3 letter currency code - **deviceType** (string) - Device type - **priceMinute** (string) - Price per minute - **borrowSlot** (integer) - Borrow slot - **returnTime** (string) - Return time - **borrowStatus** (integer) - Borrow status (0: Not leased, 1: Under lease, 2: Revoked, 3: Returned, 4: In doubt, 5: Timeout returned, 6: Charging suspended) - **deposit** (integer) - Deposit #### Response Example ```json { "msg": "Success", "code": 200, "data": { "cabinetId": "CAB123", "orderId": "ORD456", "batteryId": "BAT789", "dailyMaxPrice": 100, "freeMinutes": 30, "orderAmount": 50, "borrowTime": "2023-02-21T11:55:27Z", "price": 0.5, "currency": "USD", "deviceType": "ModelX", "priceMinute": "0.01", "borrowSlot": 1, "returnTime": "2023-02-21T15:55:27Z", "borrowStatus": 3, "deposit": 100 } } ``` ``` -------------------------------- ### GET /cabinet/eventPush/config/get Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-136071391 Retrieves the current configuration for cabinet event push notifications. This endpoint allows users to fetch details about the push URL and event subscriptions for cabinet-related events. It uses basic authentication for secure access. ```APIDOC ## GET /cabinet/eventPush/config/get ### Description Retrieves the current configuration for cabinet event push notifications, including the default push URL and a list of subscribed events with their individual settings. ### Method GET ### Endpoint /cabinet/eventPush/config/get ### Parameters #### Path Parameters #### Query Parameters #### Request Body ### Request Example {} ### Response #### Success Response (200) - **code** (integer) - Response code indicating success (0 for successful operation) - **msg** (string) - Response message (e.g., "Successful operation") - **data** (object) - Configuration data containing pushUrl and eventSubscriptions - **pushUrl** (string) - URL for receiving cabinet event push notifications; used as default if event-specific URL is not set - **eventSubscriptions** (array of objects) - List of subscribed cabinet events - **event** (string) - Type of cabinet event (e.g., CABINET_ONLINE, CABINET_OFFLINE) - **pushUrl** (string) - Optional specific URL for this event's push notifications - **enable** (boolean) - Whether push notifications are enabled for this event #### Response Example { "code": 0, "msg": "Successful operation", "data": { "pushUrl": "https://receiving.push.com/event", "eventSubscriptions": [ { "event": "CABINET_ONLINE", "pushUrl": "", "enable": true }, { "event": "CABINET_OFFLINE", "pushUrl": "", "enable": true }, { "event": "CABINET_STATUS", "pushUrl": "", "enable": true }, { "event": "BATTERY_IN", "pushUrl": "", "enable": true }, { "event": "BATTERY_BORROW_OUT", "pushUrl": "", "enable": true }, { "event": "BATTERY_ABNORMAL_WARNING", "pushUrl": "", "enable": true }, { "event": "ADMIN_RENTAL_ORDER", "pushUrl": "", "enable": true }, { "event": "POS_INFO_STATUS", "pushUrl": "", "enable": true } ] } } ``` -------------------------------- ### GET /cabinet/detail/{cabinetId} Source: https://s.apifox.cn/4855b8fe-4c43-48f6-8bd6-37cc29b98fe5/api-104222001 Retrieves detailed information about a specific cabinet device including its configuration, status, and associated lamp theme. Requires a valid device ID in the path parameter and optional Basic authentication. ```APIDOC ## GET /cabinet/detail/{cabinetId} ### Description Queries detailed information about a specific cabinet device including its configuration, status, and associated lamp theme entity. ### Method GET ### Endpoint /cabinet/detail/{cabinetId} ### Parameters #### Path Parameters - **cabinetId** (string) - Required - Device identifier for the cabinet to query #### Query Parameters - No query parameters #### Request Body - No request body required #### Header Parameters - **Authorization** (string) - Optional - Basic authentication header (e.g., Basic dGVzdDp0ZXN0) ### Request Example ```json { "authorization": "Basic dGVzdDp0ZXN0" } ``` ### Response #### Success Response (200) - **msg** (string) - Response message - **code** (integer) - Response status code - **lampTopicEntity** (object) - Lamp theme configuration object containing: - **pId** (integer) - Primary key id - **pTopicName** (string) - Subject name - **pLampColor** (string) - Color configuration - **pState** (string) - status - **pCreateDate** (string) - creation time - **pCreateOperator** (string) - founder - **pLastUpdateTime** (string) - Last modified time - **pLastUpdateOperator** (string) - Last modified by - **cabinet** (object) - Cabinet device information containing: - **pId** (integer) - Primary key id - **pCabinetid** (string) - Device id - **pType** (string) - Type of equipment (5/12/24/48 slots devices) - **commFirmwareVersion** (string) - Communication module firmware version - **commModel** (string) - Communication module model - **firmwareVersion** (string) - MCU model of main control board - **mainModel** (string) - MCU model of main control board - **pTotal** (integer) - total - **pBorrow** (integer) - Rentable quantity - **pAlso** (integer) - Recoverable quantity - **pRegtime** (string) - Registration time #### Response Example ```json { "msg": "success", "code": 200, "lampTopicEntity": { "pId": 1, "pTopicName": "Default Theme", "pLampColor": "#FF0000", "pState": "active", "pCreateDate": "2023-01-01T00:00:00Z", "pCreateOperator": "admin", "pLastUpdateTime": "2023-01-01T00:00:00Z", "pLastUpdateOperator": "admin" }, "cabinet": { "pId": 1, "pCabinetid": "SAB02371", "pType": "24", "commFirmwareVersion": "v2.1.0", "commModel": "CC-1000", "firmwareVersion": "v1.5.2", "mainModel": "STM32F103", "pTotal": 24, "pBorrow": 20, "pAlso": 4, "pRegtime": "2023-01-01T00:00:00Z" } } ``` ```