API and Integration
Inspire exposes two distinct integration surfaces:
- the Legacy Optymyse Connector API for existing Optymyse v5/v6 connector binaries
- the Data Ingest API for all new connector and external data integration work
Available APIs
| API | Purpose | Authentication |
|---|---|---|
| Data Ingest API | Preferred API for data, heartbeats, logs, and connector bootstrap | Bearer ingest credential |
| Webhook Ingestion | Lightweight webhook-style push into a stream | Bearer ingest credential |
| Legacy Optymyse Connector API | Exact compatibility surface for non-upgradable Optymyse v5/v6 connectors | Legacy connector auth |
Base URL
All API endpoints are available at:
https://inspire.yourcompany.com/api/API style
The Data Ingest API is designed around a few operational rules:
- bearer-token auth per connector
- JSON request and response bodies
- request tracing via request IDs
- stable endpoint shapes
- explicit separation between connector bootstrap and data submission
The Legacy Optymyse Connector API is intentionally excluded from those design changes and remains frozen for compatibility.
Last updated on