1. Harbor Gateway Local API
Harbor Gateway
  • Harbor Gateway Local API
    • How to Use Harbor Gateway Local API
    • Health & Status
      • Admin interface
      • Health check
    • Transactions
      • List all transactions
      • Create a transaction
      • Get transaction details
      • Release transaction
      • Open locker by transaction ID
    • Lockers
      • List all lockers
      • Get locker configuration
      • Get locker details
      • Update locker service state
      • Open locker by ID
      • Open all lockers
    • Locker Types
      • List all locker types
      • Get locker type details
    • Bank Types
      • List all bank types
      • Get bank type with associations
    • System
      • Receive heartbeat from external device
    • Schemas
      • Locker
      • LockerTypeSummary
      • TransactionResponse
      • LockerType
      • LockController
      • LockerConfig
      • System
      • LogEntry
      • OperationResponse
      • LockerOperationResponse
      • MultiStatusOperationResponse
      • BankType
      • OpenAllLockersResponse
      • BankTypeAssociation
      • Error
      • BankTypeWithAssociations
      • DeviceHeartbeatRequest
  • Harbor Gateway Cloud API
    • How to Use Harbor Gateway Cloud API
    • Meta
      • API version probe
    • Session
      • Identify the authenticated API key
      • List locations accessible to this API key
    • Requests
      • Poll a pending request
    • Locations
      • Gateway health check
    • System
      • Gateway system info
    • Transactions
      • List transactions at a location
      • Create a transaction
      • Fetch a transaction
      • Release a transaction
      • Open the locker assigned to a transaction
    • Lockers
      • List lockers
      • Locker configuration
      • Fetch a locker
      • Update a locker (e.g. out-of-service)
      • Open a specific locker
    • Types
      • List locker types
      • Fetch a locker type
      • List bank types
      • Fetch a bank type
    • Schemas
      • ApiMeta
      • MeResponse
      • LocationSummary
      • LocationList
      • PendingRequest
      • Error
      • CreateTransactionBody
      • PatchLockerBody
  1. Harbor Gateway Local API

How to Use Harbor Gateway Local API

REST API for managing smart locker transactions and physical operations.
This service runs on a computer embedded within a smart locker installation and provides an API for managing locker transactions and operations over a local area network.
Key Features:
Create and manage transactions
Control physical locker door operations (open individual lockers or all lockers)
Access system information including network details
Retrieve system logs for debugging and monitoring
Physical Context:
Service discovery via mDNS on the local network
Multiple locker towers per installation, each with independent control boards
A "tower" is the physical locker bank structure
A "control board" is the embedded electronics that control a tower
Door operations include sensor feedback (physical door state)
Transactions persist locally in a database
Important Notes:
The system does NOT track physical items, only transaction status
Customers cannot specify which locker to assign - the system selects automatically
Door open operations: 20-second timeout per attempt, up to 3 attempts with 1-second delays between retries (maximum total time ~62 seconds). Retries occur on network/communication errors only; hardware malfunctions are not retried.
Locker status uses independent boolean flags (outOfService, operational, doorOpen) that can coexist and the available flag is derived from them
Diagnostic info (reasonCode, reason) provided when lockers are unavailable
Typical Workflow:
1.
Create a transaction → System assigns an available locker
2.
Open locker by transaction ID → Place item in locker
3.
Open locker again → Remove item from locker
4.
Delete transaction → Release locker for reuse
Modified at 2026-04-25 04:23:29
Next
Admin interface
Built with