THIRD-PARTY INTEGRATION
Use OAL without depending on OpenAstroSuite.
For planetariums, automation services, mobile/desktop clients, dashboards and other astronomy software.
1. Discover, do not guess
Start with /api/v1/node/info, backends, drivers, devices, state and per-device capabilities. Do not infer controls from a vendor/display name.
2. Follow operations
Long-running work transitions queued → running → succeeded|failed|cancelled. Observe operation IDs and cancel explicitly.
3. Separate state from pixels
JSON events use the event WebSocket. Preview uses binary OALV /video or WebRTC /webrtc DataChannels. Preview loss is not science-data loss.
4. Plan for pre-1.0 evolution
Query capabilities/version, tolerate unknown fields and avoid undocumented payloads. Durable event replay, final error semantics, TLS/auth/RBAC and some science-data APIs are still OAL 1.0 work.
Security
Use current development nodes on trusted LAN/VPN only; do not expose unauthenticated ports directly to the public Internet.
Canonical guide: docs/INTEGRATION_GUIDE.md · OpenAPI