Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ixo.world/llms.txt

Use this file to discover all available pages before exploring further.

This page covers the Impact Hub Registry service API. It is not a direct IXO Protocol gateway and should be treated as an application/service surface.

​
Overview

  • Service scope includes registry-facing workflows such as project, household, device, credit, and claim reporting interfaces.
  • Protocol-level claim semantics and module transactions belong to IXO Protocol API pages.

​
Authentication

Registry deployments can use service-specific credentials. The historical examples for this surface include HTTP Basic auth. 
Authorization: Basic <base64(username:password)>
Do not assume one auth scheme across all registry environments. Confirm active requirements in /reference/authentication-matrix.

​
Endpoint groups

  • System health and API docs
  • Household and device reporting
  • Fuel and claims reporting
  • Credit lifecycle reporting

​
Known literal handling

Historical environment literals for this surface have appeared in previous docs. This page no longer treats those values as canonical source of truth.

Canonical endpoints

Use network and environment endpoint mappings as source of truth.

Canonical auth requirements

Confirm active authentication requirements before integration.

​
Troubleshooting

  • 401 Unauthorized with Basic auth — Wrong username/password or environment rotated credentials; re-read the deployment row in Authentication matrix.
  • 403 Forbidden — Authenticated but missing role or scope for that registry route; check operator RBAC and which program the credentials belong to.
  • 404 on resource paths — Registry API versions and path prefixes differ by deployment; confirm OpenAPI/base URL with your operator (Networks and endpoints).
  • Payload validation errors — Compare field names to the operator’s schema; many issues are missing required reporting fields, not transport failures (Error handling).

Registry guide

Follow task-oriented guidance for registry workflows.

API authentication

Review authentication patterns used across IXO API interfaces.

Product and SDK map

Navigate IXO products, APIs, and SDK references.