Overview of Streaming API

The following sequence diagram provides a visual representation of the OHIP Streaming API's operation, illustrating the interactions between the client system, OHIP Streaming API, and OPERA Cloud.

The below state chart illustrates the full lifecycle of a client connection to the OHIP Streaming API.

When building an integration, use this diagram as a practical reference to design your client's logic for connection handling, subscription flow, error management, and safe recovery from disconnections or token expiries. Use this as a checklist to ensure your implementation properly manages pings, offset tracking, reconnections with offsets, rate limits, and duplicate suppression.

When troubleshooting an integration, refer to this chart to quickly identify which state or transition your client is experiencing (such as specific close/error codes or lockouts), and to guide your next steps, such as waiting before reconnecting, refreshing tokens, or resynchronizing through REST, helping you diagnose and resolve operational or configuration issues efficiently.

• If You Are Used to Polling APIs
  
• For Experienced WebSocket/GraphQL Developers
  
• Subscribing and Consuming Events
  
• Replaying Events
  
• Receiving the Latest Event
  
• Note to Programmatic Consumers
  
• Suppressing Events from Your Own REST Calls
  
• Backpressure Mode
  
• Orchestration
  
• Interpreting the Event
  
• Examples of the Subscribe Call