Avnology ID
API ReferenceSSF

SSF Configuration

Discover your tenant's SSF transmitter metadata.

RPCs

MethodPath
GetConfigurationGET /.well-known/ssf-configuration

Base URL: https://<Domain id="api"/>

Authentication: None (discovery endpoint).

Returns the Shared Signals Framework transmitter metadata document -- the URLs receivers need to provision streams, the supported delivery methods, signing key locations, and the list of supported event types.

Example

Response (200 OK)

{
  "issuer": "https://api-id.avnology.net",
  "jwks_uri": "https://api-id.avnology.net/.well-known/jwks.json",
  "configuration_endpoint": "https://api-id.avnology.net/v1/ssf/streams",
  "delivery_methods_supported": [
    "urn:ietf:rfc:8935",
    "urn:ietf:rfc:8936"
  ],
  "supported_signing_algorithms": ["RS256", "ES256"]
}

Poll & Acknowledge Events

For poll-mode SSF streams -- pull pending events, then acknowledge.

API Reference

Interactive API documentation for Avnology ID with code samples in 20+ languages.

On this page