Protocols, URLs and Configurations

Supported Protocols

• HTTPS
• MQTT (currently not supported in Python client library)

Supported Package Types

• ISO19848 DataChannelList
• ISO19848 TimeSeriesData

Client configuration

.NET

We provide a .NET client library to simplify the ingestion of data into the Vista Gateway. The library is available as a NuGet package. See DNV.Vista.Gateway.Client README for documentation.

Python

We provide a Python client library to simplify the ingestion of data into the Vista Gateway. The library is available as a PyPI package. See vista-gateway-client README for documentation.

No client library

HTTPS

URLs:

• Production: https://vista-gateway-api.dnv.com
• Customer test: https://vista-gateway-customer-test-api.dnv.com

Endpoints:

• POST /ISO19848

Swagger:

• https://vista-gateway-api.dnv.com/mqtt/swagger
• https://vista-gateway-customer-test-api.dnv.com/mqtt/swagger

Required headers:

• Content-Type: application/json
• Authorization: ApiKey <API_KEY>
• User-Agent: User agent

Optional headers:

• X-Package-External-Id: External identifier
• X-Package-Correlation-Id: Correlation identifier

Payload:

• ISO19848 DataChannelList or TimeSeriesData

MQTT

URLs:

• Production: wss://vista-gateway-api.dnv.com/mqtt
• Customer test: wss://vista-gateway-customer-test-api.dnv.com/mqtt

Endpoints:

• /ISO19848

Connections configuration:

• Server type: WebSocket
• Protocol: MQTT
• Protocol version: V5
• Credentials:
  • Username: connection - fixed value
  • Password: <API_KEY>
  • Example: connection:my-api-key

Message configuration:

• Topic: ISO19848
• QoS: AtLeastOnce = 0x01
• Retain: false
• Content type: application/json
• Optional properties:
  • externalId: Some external identifier
  • correlationId: Some correlation identifier

Payload:

• ISO19848 DataChannelList or TimeSeriesData