API documentation
The Opinum API is available on api.opinum.com. A swagger is available to discover the API.
Opinum API versionning
At present, the Data Hub API is at version 1.7. For reasons of backward compatibility, we maintain the following versions:
| Version | Link | Status | End of life |
|---|---|---|---|
| 1.7 | https://api.opinum.com | ||
| 1.6 | https://api.opinum.com/swagger/index.html?urls.primaryName=V1.6 | Deprecated | MIGRATE |
| 1.5 | https://api.opinum.com/swagger/index.html?urls.primaryName=V1.5 | Deprecated | MIGRATE |
| 1.4 | https://api.opinum.com/swagger/index.html?urls.primaryName=V1.4 | Deprecated | MIGRATE |
| 1.3 | https://api.opinum.com/swagger/index.html?urls.primaryName=V1.3 | Deprecated | ASAP |
| 1.2 | https://api.opinum.com/swagger/index.html?urls.primaryName=V1.2 | Deprecated | ASAP |
| 1.1 | https://api.opinum.com/swagger/index.html?urls.primaryName=V1.1 | Deprecated | ASAP |
| 1.0 | https://api.opinum.com/swagger/index.html?urls.primaryName=V1 | Deprecated | ASAP |
We create a new version every time we introduce a breaking change to the API. If we add new properties or options that are not mandatory, we maintain the same version.
Select the version to use :
By default, Data Hub will select the latest API version available.
If you wish to use a later version, you must specify this in a header in your requests. The header name is “Api-Version” and the value is the corresponding version number. This version number is available in the table above, and when you use our Swagger, the version is added automatically.
If you're building an integration on top of the Data Hub API, we strongly recommend that you specify the version you're using at the time of implementation. Otherwise, as specified above, when we deploy a new version, your calls will automatically use the latest version available.
Discover now how to connect to the API.