Skip to Content
API & IntegrationLegacy Optymyse Connector API

Legacy Optymyse Connector API

Inspire includes a backward-compatible API layer for existing integrations built against the Optymyse v5/v6 connector platform. This layer is intentionally frozen so deployed legacy connectors can continue running unchanged.

This API is provided for backward compatibility only. New integrations should use the Data Ingest API. Legacy Optymyse behavior is preserved as-is; new platform work happens in the Data Ingest API.

Endpoint

POST /api/v1/data/{connector-id}

Authentication

The Legacy Optymyse Connector API uses the same authentication method as the legacy platform:

X-API-Key: your-api-key

Existing legacy API keys continue to work in Inspire. New API keys can be generated in Settings > API Keys.

Request Format

This API accepts the same JSON format as the legacy Optymyse API:

POST /api/v1/data/my-connector X-API-Key: abc123... Content-Type: application/json { "items": [ { "id": "north", "values": { "Revenue": 142000, "Target": 130000 } } ] }

Compatibility guarantee

For legacy connector binaries, this surface is treated as a hard compatibility boundary:

  • same auth model
  • same casing rules
  • same request shapes
  • same response semantics
  • same signature/body handling behavior

That is why new connector development should move to the Data Ingest API instead of extending the legacy connector surface.

Migration Path

To migrate from the Legacy Optymyse Connector API to the Data Ingest API:

  1. Create a connector in Data Sources to get an Inspire ik_<key_id>_<secret> ingest key
  2. Update your API client:
    • Change the URL from /api/v1/data/{id} to /api/ingest
    • Change auth from the legacy headers to Authorization: Bearer ik_<key_id>_<secret>
    • Send { stream, items[] } requests
  3. Test with the new endpoint
  4. Switch over
Last updated on