Interactive documentation

Explore OpenAPI specifications and test endpoints directly

OpenAPI 3.0 JSON /swagger/v1/swagger.json Swagger UI /swagger Scalar API Reference /scalar/v1

Postman environment template

Download or copy environment variables for local integration testing

postman-environment.json

{
  "baseUrl": "http://127.0.0.1:5110",
  "merchantApiKey": "dev-rfgateway-key",
  "apiKey": "dev-rfgateway-key",
  "adminKey": "development-admin-key",
  "storeCode": "Store_1",
  "referenceId": "ERP-SYNC-20260829-001",
  "productCode1": "ITEM001",
  "productCode2": "ITEM002",
  "unknownProductCode": "UNKNOWN-999"
}

Inventory Sync Integration

Client-driven store inventory balance snapshot, ledger math, idempotency, and ExtraFields metadata

Client-Driven Sync Push FullSnapshot via POST /v1/merchant/inventory/sync

Movement Ledger Zero silent overwrites; CLIENT_SYNC_VARIANCE math

Precision Idempotency ReferenceId caching prevents duplicate stock adjustments

ExtraFields Metadata Recursive sanitization; up to 5 levels, reserved/secret key blocking

Integration Architecture: RFGateWay acts as the receiver, validator, and movement ledger writer. External ERP/POS jobs maintain their own schedule and push snapshots periodically. See docs/merchant-integration-guide.md and .ai/06-api-contracts/MERCHANT-INVENTORY-SYNC.md for full specifications.

cURL integration recipes

Tenant endpoints authenticate via x-api-key; admin endpoints authenticate via x-admin-key

# 1. Fetch available store locations
curl -H "x-api-key: dev-rfgateway-key" http://127.0.0.1:5110/v1/merchant/store?min=true

# 2. Product batch import
curl -X POST -H "x-api-key: dev-rfgateway-key" -H "Content-Type: application/json" http://127.0.0.1:5110/v1/merchant/products/import?count=1&lastBatch=true&sid=Store_1 -d "{\"products\":[{\"sample_unique_code\":\"CODE1\",\"quantity\":5}]}"

# 3. Push real store inventory snapshot (FullSnapshot)
curl -X POST -H "x-api-key: dev-rfgateway-key" -H "Content-Type: application/json" http://127.0.0.1:5110/v1/merchant/inventory/sync -d "{\"storeCode\":\"Store_1\",\"syncMode\":\"FullSnapshot\",\"referenceId\":\"ERP-SYNC-001\",\"items\":[{\"productCode\":\"CODE1\",\"quantity\":25}]}"

# 4. Internal admin tenant list (requires admin key)
curl -H "x-admin-key: {admin-key}" http://127.0.0.1:5110/internal/admin/tenants

Client SDK & package generation

Generate type-safe .NET and TypeScript API clients from the OpenAPI specification

The ET.RFGateWay .NET Client SDK is packaged under ET.RFGateWay.ApiClient. For custom integrations, generate clients using NSwag from /swagger/v1/swagger.json or TypeScript clients via openapi-typescript-codegen. Remember to pass x-api-key for merchant API endpoints and x-admin-key or JWT Bearer for internal operations.

API Delivery