OpenVeo Publish server

API Docs for: 8.0.0
Show:

TlsClient

Extends RestClient
Defined in: app/server/providers/mediaPlatforms/tls/TlsClient.js:10
Module: providers

Summary

Creates a client to connect to TLS web service.

Constructor

TlsClient

Defined in app/server/providers/mediaPlatforms/tls/TlsClient.js:10

Syntax

TlsClient

(
  • webServiceUrl
  • accessToken
  • [certificate]
)

Summary

Parameters:

  • webServiceUrl String

    The complete URL of the TLS web service

  • accessToken String

    Access token to authenticate requests to the web service

  • [certificate] String optional

    Absolute path to the web service full chain certificate file

Example:

const OpenVeoClient = require('@openveo/rest-nodejs-client').OpenVeoClient;
const client = new TlsClient(
            'https://tls-web-service-host/path/to/web/service',
            'access token',
            '/absolute/path/to/full/chain/certificate.crt'
);

Methods

getAuthenticationHeader

Defined in app/server/providers/mediaPlatforms/tls/TlsClient.js:70

Syntax

getAuthenticationHeader

() Object private

Summary

Builds authentication headers.

Returns:

Object:

The authentication headers to send with each request

isAuthenticated

Defined in app/server/providers/mediaPlatforms/tls/TlsClient.js:60

Syntax

isAuthenticated

() Boolean

Summary

Indicates if client is authenticated to the server.

Returns:

Boolean:

true as no authentication is performed on TLS server

Properties

authenticateRequest

Defined in app/server/providers/mediaPlatforms/tls/TlsClient.js:41

Syntax

authenticateRequest

Object final

Summary

The authenticate request to get an access token.

As TLS does not have an authentication request, this is a fake request.