API documentation
The Device Portal provides three public APIs.
The placeholder <NEXEED_HOST> refers to the hostname (URL) of your Device Portal installation.
| In a subdomain deployment, the placeholder includes the subdomain (e.g. dp.<NEXEED_HOST>). |
The public API for solutions which want to integrate with the Device Portal is exposed under
https://<NEXEED_HOST>/dp/solution/ and its documentation under
https://<NEXEED_HOST>/dp/solution/index.html.
For the NEXEED cloud installation, you can follow this link accordingly.
The public API for devices is exposed under
https://<.Values.global.modules.deviceportal.mtlsGateway.deviceDomain>/
and its documentation under
https://<NEXEED_HOST>/dp/device/index.html.
For the NEXEED cloud installion, you can follow this link accordingly.
The public API of the Managed Artifact Repository is exposed under
https://<.Values.global.modules.deviceportal.mtlsGateway.deviceDomain>/artifact-repository/ (for devices) and
https://<NEXEED_HOST>/dp/artifact-repository/ (for users).
Its documentation and user guide can be found under
https://<NEXEED_HOST>/dp/artifact-repository/index.html.
For the NEXEED cloud installion, you can follow this link accordingly.
These APIs are stable and versioned. APIs not documented here or in the links provided are subject to change without notice.