Intent One Gateway v1.2.0

Public API for integrators. Any request whose method/path doesn't match one of the operations below is also accepted: authenticate with X-Client-Id (see security schemes) and it's queued for asynchronous processing the same way as the documented endpoints — this generic fallback isn't representable as a single OpenAPI operation, so it's noted here instead of in `paths`.

Machine-readable spec: /openapi.json

Servers

Authentication

Public API

Account management

Provisioning endpoints. Each requires a bearer token credential — contact your Intent One representative to obtain one.

Example

curl -i https://intent-one-gateway-staging.ihq-eng.dev/ \
  -H "X-Client-Id: $CLIENT_ID" \
  -X POST -d '{"hello":"world"}'
# -> 202 {"accepted":true,"requestId":"..."}

Example: /edge/v1/report

The body may be a single report object, or a JSON array of report objects submitted as a batch in one request. It may optionally be gzip-compressed — signal this with either the standard Content-Encoding: gzip header, or a Content-Type that names gzip directly (e.g. content-gzip). Report type/timeliness/version resolve from x-sdk-report-type/x-sdk-report-timeliness/x-sdk-report-version headers (each optional and independent), falling back to auto-detection/a default of realtime for whichever isn't supplied that way — or POST to /edge/v1/report/{type}/{timeliness}/{version} instead to declare all three via the URL, mirroring edge-reports-api's own route.

# A single report
curl -i https://intent-one-gateway-staging.ihq-eng.dev/edge/v1/report \
  -H "x-sdk-app-name: $APP_NAME" \
  -H "x-sdk-api-key: $APP_API_KEY" \
  -H "Content-Type: application/json" \
  -X POST -d '{"SDKVersion":"1.2.3","Microsegments":[{"Name":"seg","Value":"x"}]}'
# -> 202 {"accepted":true,"requestId":"...","reportType":"microsegments","protocolVersion":"v2","timeliness":"realtime","sdkVersion":"1.2.3"}

# A batch of reports in one request
curl -i https://intent-one-gateway-staging.ihq-eng.dev/edge/v1/report \
  -H "x-sdk-app-name: $APP_NAME" \
  -H "x-sdk-api-key: $APP_API_KEY" \
  -H "Content-Type: application/json" \
  -X POST -d '[{"SDKVersion":"1.2.3","Microsegments":[{"Name":"seg","Value":"x"}]}, {"SDKVersion":"1.2.3","Microsegments":[{"Name":"seg2","Value":"y"}]}]'
# -> 202 {"accepted":true,"requestId":"...","reportType":"microsegments","protocolVersion":"v2","timeliness":"realtime","sdkVersion":"1.2.3"}

# Gzip-compressed body — either header works
gzip -c report.json > report.json.gz
curl -i https://intent-one-gateway-staging.ihq-eng.dev/edge/v1/report \
  -H "x-sdk-app-name: $APP_NAME" \
  -H "x-sdk-api-key: $APP_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Content-Encoding: gzip" \
  --data-binary @report.json.gz \
  -X POST
# -> 202 {"accepted":true,"requestId":"...","reportType":"microsegments","protocolVersion":"v2","timeliness":"realtime","sdkVersion":"1.2.3"}

# A different report type — same endpoint, detected automatically
curl -i https://intent-one-gateway-staging.ihq-eng.dev/edge/v1/report \
  -H "x-sdk-app-name: $APP_NAME" \
  -H "x-sdk-api-key: $APP_API_KEY" \
  -H "Content-Type: application/json" \
  -X POST -d '{"SDKVersion":"1.2.3","DataVersion":2,"ReportUserID":"u1","ReportMode":"core","WifiEnabled":"true","LocationEnabled":true}'
# -> 202 {"accepted":true,"requestId":"...","reportType":"usage","protocolVersion":"v2","timeliness":"realtime","sdkVersion":"1.2.3"}

# Declaring the report type explicitly instead of relying on auto-detection —
# a body that doesn't match it is rejected (report_type_mismatch), even if it
# would otherwise auto-detect as a different type
curl -i https://intent-one-gateway-staging.ihq-eng.dev/edge/v1/report \
  -H "x-sdk-app-name: $APP_NAME" \
  -H "x-sdk-api-key: $APP_API_KEY" \
  -H "x-sdk-report-type: usage" \
  -H "Content-Type: application/json" \
  -X POST -d '{"SDKVersion":"1.2.3","ReportMode":"core","WifiEnabled":"true"}'
# -> 202 {"accepted":true,"requestId":"...","reportType":"usage","protocolVersion":"v2","timeliness":"realtime","sdkVersion":"1.2.3"}

# Declaring type + version together trusts the version outright (no
# structural check), and timeliness independently — none of these three need
# each other to be present
curl -i https://intent-one-gateway-staging.ihq-eng.dev/edge/v1/report \
  -H "x-sdk-app-name: $APP_NAME" \
  -H "x-sdk-api-key: $APP_API_KEY" \
  -H "x-sdk-report-type: usage" \
  -H "x-sdk-report-version: v3" \
  -H "x-sdk-report-timeliness: historical" \
  -H "Content-Type: application/json" \
  -X POST -d '{"SDKVersion":"1.2.3","ReportMode":"core","WifiEnabled":"true"}'
# -> 202 {"accepted":true,"requestId":"...","reportType":"usage","protocolVersion":"v3","timeliness":"historical","sdkVersion":"1.2.3"}

# Or declare all three via the URL instead — edge-reports-api's own path
# convention, the form an SDK transitions onto before this gateway is
# eventually removed from the path entirely
curl -i https://intent-one-gateway-staging.ihq-eng.dev/edge/v1/report/usage/historical/v3 \
  -H "x-sdk-app-name: $APP_NAME" \
  -H "x-sdk-api-key: $APP_API_KEY" \
  -H "Content-Type: application/json" \
  -X POST -d '{"SDKVersion":"1.2.3","ReportMode":"core","WifiEnabled":"true"}'
# -> 202 {"accepted":true,"requestId":"...","reportType":"usage","protocolVersion":"v3","timeliness":"historical","sdkVersion":"1.2.3"}