v1 Legacy API
Inspire includes a backward-compatible v1 API layer for existing integrations built against the legacy API. This allows you to migrate to Inspire without immediately updating all your API clients.
The v1 API is provided for backward compatibility only. New integrations should use the Data Ingestion API. The v1 API will be maintained but will not receive new features.
Endpoint
POST /api/v1/data/{connector-id}Authentication
The v1 API uses the same authentication method as the legacy platform:
X-API-Key: your-api-keyExisting legacy API keys continue to work in Inspire. New API keys can be generated in Settings > API Keys.
Request Format
The v1 API accepts the same JSON format as the legacy API:
POST /api/v1/data/my-connector
X-API-Key: abc123...
Content-Type: application/json
{
"items": [
{
"id": "north",
"values": {
"Revenue": 142000,
"Target": 130000
}
}
]
}Differences from the Legacy API
| Aspect | Legacy | Inspire (v1 compat) |
|---|---|---|
| Base URL | /api/data/ | /api/v1/data/ |
| Authentication | X-API-Key header | Same |
| Response format | Custom JSON | Standardised JSON envelope |
| Rate limiting | None | Applied (see API Overview) |
Migration Path
To migrate from the v1 API to the Data Ingestion API:
- Create a connector in Data Sources to get an
ik_ingest key - Update your API client:
- Change the URL from
/api/v1/data/{id}to/api/ingest - Change auth from
X-API-KeytoAuthorization: Bearer ik_... - Flatten the
items[].valuesstructure to a flat JSON object
- Change the URL from
- Test with the new endpoint
- Switch over
Last updated on