This is the reference table of which credentials each IXO interface takes. IXO interfaces do not share one way to authenticate, so look up the row for the interface you are calling instead of applying one pattern everywhere.
For help choosing, read Choose how to authenticate to an IXO API.
Scope
- Covers the authentication patterns that the IXO docs explicitly document.
- Separates protocol gateways from service APIs.
- Collects in one place the header examples used across guides and API pages.
Authentication by interface
| Interface | Who owns access policy | Documented pattern | Header example |
|---|---|---|---|
| Blockchain RPC API | Node / operator policy | Deployment-specific | Confirm per endpoint and operator policy |
| Blockchain REST API (gRPC gateway) | Node / operator policy | Deployment-specific | Confirm per endpoint and operator policy |
| IXO Blocksync GraphQL API | Service operator policy | Service-specific credential model | Confirm service deployment requirements |
| Matrix state bot API | Service operator policy | Service-specific credential model | Confirm service deployment requirements |
| Registry API | Service operator policy | Historical Basic auth example | Authorization: Basic <base64(username:password)> |
| Emerging Platform API (OpenAPI set) | Service operator policy | Unauthorized responses defined in schema | Confirm active header contract for deployment |
| USSD gateway API | Deployer / reverse proxy | Often unauthenticated at app layer; restrict at network edge | No default header. Use network controls in production. |
Header formats used in the docs
Authorization: Bearer <token>X-API-Key: <api_key>Authorization: Basic <base64(username:password)>Warning
Do not treat any one header as globally valid across all IXO interfaces.
Where to get credentials
- Protocol gateways: get the access policy from the operator of your target node or network.
- Service APIs: get credentials from the service operator for the environment you use.
- Confirm endpoint and environment mappings in Networks and endpoints.
Secret management
| Practice | What to do |
|---|---|
| Environment variables | Load API keys, Basic passwords, Matrix tokens and database URLs from the environment or a secrets manager. Never commit them to git or embed them in client-side bundles. |
| Rotation | When operators rotate credentials, update your deployment config first, then redeploy clients. Prefer short-lived tokens where the service supports them. |
| Least privilege | Use separate credentials per environment (dev/staging/prod) and per integration, so a leak does not span systems. |
| Logs | Strip authorization headers and tokens from application logs and exception reports. |