nexxOMNIA API
  • Introduction
  • API Design
    • Endpoint and Authorization
    • Query Parameters
    • Response Object
  • Media API
    • Usage
    • Endpoints
      • Media Data
      • All Media Data
      • Template Data
      • Processing
  • Management API
    • Usage
    • Endpoints
      • Domain Data
      • System Data
      • Media Management
      • Media Export Management
      • Domain Management
      • Statistics
  • Frontend API
    • Usage
    • Endpoints
      • Media Interactions
      • Session Management
      • User Endpoint
      • Payment Processing
  • API Clients
    • PHP
    • NodeJS
  • Notification Gateway
  • Changelog
Powered by GitBook
On this page
  • Domain Attributes
  • /publicinfo
  • /instantconfiguration
  • /offlineconfiguration
  • /uploadconfiguration
  • Domain Associations
  • /apps
  • /campaigns
  • /accounts
  • /liveconnections
  • /channels
  • /formats
  • /videocategories
  • /audiocategories
  • /imagecategories
  • /filecategories
  • /articlecategories
  • /eventcategories
  • /placecategories
  • /productcategories
  • /tags
  • /autoupdatefeeds
  • /previewlinks
  • /broadcastlinks
  • /dashboardlinks
  • /uploadlinks
  • /downloadlinks
  • /widgets
  • /prices
  • /affiliatepartners
  • /adproviders
  • /payproviders
  • /avsproviders
  • /licensors
  • /deliverypartners
  • /paymodel
  • /texttemplates
  • Network Relations
  • /networkdomains
  • System User Relations
  • /systemusers

Was this helpful?

  1. Management API
  2. Endpoints

Domain Data

The Domain Endpoint returns Lists of Domain Attributes or associated Resources, that are not Media Items.

Domain Attributes

/publicinfo

GET https://api.nexx.cloud/v3.1/domain/publicinfo

Query Parameters

Name
Type
Description

addCustomAttribues

boolean

addChannels

boolean

addFormats

boolean

/instantconfiguration

GET https://api.nexx.cloud/v3.1/domain/instantconfiguration/:token

returns all necessary Details for Domain API Access via a One-Time Token. Often used to configure a Backend automtically without the need to memorize all API Secrets and Session Details.

Path Parameters

Name
Type
Description

token

string

The One-Time Token for the calling Domain

/offlineconfiguration

GET https://api.nexx.cloud/v3.1/domain/offlineconfiguration

returns all necessary Details for Handling the Offline Playback System. This Endpoint is normally only relevant for nexxPLAY.

/uploadconfiguration

GET https://api.nexx.cloud/v3.1/domain/uploadconfiguration

returns all necessary Details for initiating an API-driven File Upload. This Endpoint is normally only relevant for API SDKs.

Path Parameters

Name
Type
Description

file

string

the Filename, that shall be uploaded.

Domain Associations

/apps

GET https://api.nexx.cloud/v3.1/domain/apps

/campaigns

GET https://api.nexx.cloud/v3.1/domain/campaigns

/accounts

GET https://api.nexx.cloud/v3.1/domain/accounts

/liveconnections

GET https://api.nexx.cloud/v3.1/domain/liveconnections

/channels

GET https://api.nexx.cloud/v3.1/domain/channels

/formats

GET https://api.nexx.cloud/v3.1/domain/formats

/videocategories

GET https://api.nexx.cloud/v3.1/domain/videocategories

/audiocategories

GET https://api.nexx.cloud/v3.1/domain/audiocategories

/imagecategories

GET https://api.nexx.cloud/v3.1/domain/imagecategories

/filecategories

GET https://api.nexx.cloud/v3.1/domain/filecategories

/articlecategories

GET https://api.nexx.cloud/v3.1/domain/articlecategories

/eventcategories

GET https://api.nexx.cloud/v3.1/domain/eventcategories

/placecategories

GET https://api.nexx.cloud/v3.1/domain/placecategories

/productcategories

GET https://api.nexx.cloud/v3.1/domain/productcategories

/tags

GET https://api.nexx.cloud/v3.1/domain/tags

/autoupdatefeeds

GET https://api.nexx.cloud/v3.1/domain/autoupdatefeeds

will return all active (M)RSS, Podcast and Assistant AutoExporters

Query Parameters

Name
Type
Description

addStreamDetails

boolean

set to 1 to include Origin and URL Metadata

/previewlinks

GET https://api.nexx.cloud/v3.1/domain/previewlinks

will return all active PreviewLinks for all Media Items of the calling Domain

/broadcastlinks

GET https://api.nexx.cloud/v3.1/domain/broadcastlinks

will return all active BroadcastLinks for all Media Items of the calling Domain

/dashboardlinks

GET https://api.nexx.cloud/v3.1/domain/dashboardlinks

will return all active DashboardLinks for the calling Domain

/uploadlinks

GET https://api.nexx.cloud/v3.1/domain/uploadlinks

will return all active UploadLinks for the calling Domain

/downloadlinks

GET https://api.nexx.cloud/v3.1/domain/downloadlinks

will return all active DownloadLinks for the calling Domain

/widgets

GET https://api.nexx.cloud/v3.1/domain/widgets

will return all active nexxPLAY Widgets for the calling Domain

Request Body

Name
Type
Description

addStreamDetails

boolean

set to 1 to include Origin and URL Metadata

addStreamDetails

boolean

set to 1 to include Embed URLs

/prices

GET https://api.nexx.cloud/v3.1/domain/prices

/affiliatepartners

GET https://api.nexx.cloud/v3.1/domain/affiliatepartners

/adproviders

GET https://api.nexx.cloud/v3.1/domain/adproviders

/payproviders

GET https://api.nexx.cloud/v3.1/domain/payproviders

/avsproviders

GET https://api.nexx.cloud/v3.1/domain/avsproviders

/licensors

GET https://api.nexx.cloud/v3.1/domain/licensors

Query Parameters

Name
Type
Description

streamtype

string

if set, only return the Licensors for the given Streamtype

/deliverypartners

GET https://api.nexx.cloud/v3.1/domain/deliverypartners

/paymodel

GET https://api.nexx.cloud/v3.1/domain/paymodel

This Endpoint is a Shortcut for the various Payment Details. It combines the "prices" and "payproviders" with some Payment specific Text Templates and fastens the Data Query for Payment Configuration on the Frontend Side.

/texttemplates

GET https://api.nexx.cloud/v3.1/domain/texttemplates/:reference

This Endpoint returns a static TextTemplate, predefined in nexxOMNIA. It is only used in Frontend Situations, managed by 3Q nexx.

Network Relations

/networkdomains

GET https://api.nexx.cloud/v3.1/domain/networkdomains

This Call will list all Domains, that are in the same Network as the calling Domain. Bascially, the /publicinfo Result for each Domain will be included. If more Details are desired, you may add one of the following Output Modifiers.

Query Parameters

Name
Type
Description

addChannels

boolean

addFormats

boolean

addVideoCategories

boolean

addAudioCategories

boolean

addImageCategories

boolean

addFileCategories

boolean

addArticleCategories

boolean

addEventCategories

boolean

addPlaceCategories

boolean

addAccounts

boolean

addLiveConnections

boolean

addAutoUpdateFeeds

boolean

addTags

boolean

addCustomAttributes

boolean

addProductCategores

boolean

System User Relations

/systemusers

GET https://api.nexx.cloud/v3.1/domain/systemusers

This Call will list all nexxOMNIA (or nexxGO) Users, that may access the calling Domain. A List of Rights is returned too.

PreviousEndpointsNextSystem Data

Last updated 1 year ago

Was this helpful?