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 Management
  • /domains/clonefornetwork
  • /domains/:domainid/markfordeletion
  • Domain References
  • /channels/add
  • /channels/:channelid/update
  • /channels/:channelid/cover
  • /channels/:channelid/actionshot
  • /channels/:channelid/remove
  • /formats/add
  • /formats/:formatid/update
  • /formats/:formatid/cover
  • /formats/:formatid/actionshot
  • /formats/:formatid/remove
  • /:streamtypecategories/add
  • /:streamtypecategories/:categoryid/update
  • /:streamtypecategories/:categoryid/cover
  • /:streamtypecategories/:categoryid/remove
  • UploadLinks
  • /uploadlinks/add
  • /uploadlinks/:uploadlinkid/remove

Was this helpful?

  1. Management API
  2. Endpoints

Domain Management

Domain Management

To use the Domain Management APIs, the calling Domain must be part the Partner Management Group of 3Q. Contact the Support, if this is needed.

/domains/clonefornetwork

POST https://api.nexx.cloud/v3.1/manage/domains/clonefornetwork

Request Body

Name
Type
Description

title*

string

the Title of the new registered Domain

url*

string

the URL of the new registered Domain

networkmode*

string

[mixed, master, own, all] defines the Rights on Network Contents for the new Domain

refnr

string

an internal Reference Number of the Client

/domains/:domainid/markfordeletion

DELETE https://api.nexx.cloud/v3.1/manage/domains/:domainid/markfordeletion

will mark the given Domain for Deletion. The given Domain cannot be the calling Domain and must be part of the same Network. Contents of the target Domain will not be deleted.

Path Parameters

Name
Type
Description

domainid*

integer

a valid Domain ID of the Network of the calling Domain

Domain References

Domain References handles Objects and Structures, that are not considered as "Media", but belong to the Domain and serve as References.

/channels/add

POST https://api.nexx.cloud/v3.1/manage/channels/add

all Parameters of the /channels/update Methods are supported.

/channels/:channelid/update

PUT https://api.nexx.cloud/v3.1/manage/channels/:channelid/update

Path Parameters

Name
Type
Description

channelid*

integer

the ID of a Channel of the calling Domain

Request Body

Name
Type
Description

title*

string

subtitle

string

refnr

string

teaser

string

description

string

parent

integer

if the Channel shall be a Sub Channel of a parent Channel, add the parent Channel ID here

pos

integer

an optional Sorting Parameter for publically visible Channels

color

string

/channels/:channelid/cover

POST https://api.nexx.cloud/v3.1/manage/channels/:channelid/cover

Path Parameters

Name
Type
Description

channelid*

integer

the ID of a Channel of the calling Domain

Query Parameters

Name
Type
Description

url*

String

the URL to the Image, that should be used as Cover

description

String

an optional Description of the Cover

assetLanguage

string

if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover

copyright

String

an optional Copyright for the Cover

isAIGenerated

[0, 1]

if set to 1, the System will assume, that this Asset has been created by an AI.

/channels/:channelid/actionshot

POST https://api.nexx.cloud/v3.1/manage/channels/actionshot

Path Parameters

Name
Type
Description

channelid*

integer

the ID of a Channel of the calling Domain

Query Parameters

Name
Type
Description

url*

String

the URL to the Image, that should be used as ActionShot

description

String

an optional Description of the Cover

assetLanguage

String

if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover

copyright

String

an optional Copyright for the Cover.

isAIGenerated

[0, 1]

if set to 1, the System will assume, that this Asset has been created by an AI.

/channels/:channelid/remove

DELETE https://api.nexx.cloud/v3.1/manage/channels/:channelid/remove

Path Parameters

Name
Type
Description

channelid*

integer

the ID of a Channel of the calling Domain

/formats/add

POST https://api.nexx.cloud/v3.1/manage/formats/add

all Parameters of the /formats/update Methods are supported.

/formats/:formatid/update

PUT https://api.nexx.cloud/v3.1/manage/formats/:formatid/update

Path Parameters

Name
Type
Description

formatid

integer

the ID of a Channel of the calling Domain

Request Body

Name
Type
Description

title*

string

subtitle

string

refnr

string

teaser

string

description

string

/formats/:formatid/cover

POST https://api.nexx.cloud/v3.1/manage/formats/:formatid/cover

Path Parameters

Name
Type
Description

formatid*

integer

the ID of a Format of the calling Domain

Query Parameters

Name
Type
Description

url*

String

the URL to the Image, that should be used as Cover

description

String

an optional Description of the Cover

assetLanguage

String

if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover

copyright

String

an optional Copyright for the Cover.

isAIGenerated

[0, 1]

if set to 1, the System will assume, that this Asset has been created by an AI.

/formats/:formatid/actionshot

POST https://api.nexx.cloud/v3.1/manage/formats/:formatid/actionshot

Path Parameters

Name
Type
Description

formatid*

integer

the ID of a Format of the calling Domain

Query Parameters

Name
Type
Description

url*

String

the URL to the Image, that should be used as Cover

description

String

an optional Description of the Cover

assetLanguage

String

if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover

copyright

String

an optional Copyright for the Cover

isAIGenerated

[0, 1]

if set to 1, the System will assume, that this Asset has been created by an AI.

/formats/:formatid/remove

DELETE https://api.nexx.cloud/v3.1/manage/formats/:formatid/remove

Path Parameters

Name
Type
Description

channelid

integer

the ID of a Channel of the calling Domain

/:streamtypecategories/add

POST https://api.nexx.cloud/v3.1/manage/:streamtypecategories/add

all Parameters of the /channels/update Methods are supported.

Path Parameters

Name
Type
Description

streamtypecategories*

string

[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories]

/:streamtypecategories/:categoryid/update

PUT https://api.nexx.cloud/v3.1/manage/:streamtypecategories/:categoryid/update

Path Parameters

Name
Type
Description

streamtypecategories*

string

[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories]

categoryid*

integer

the ID of a Category of the given Type of the calling Domain

Request Body

Name
Type
Description

title*

string

subtitle

string

color

string

only valid for Event Categories

/:streamtypecategories/:categoryid/cover

POST https://api.nexx.cloud/v3.1/manage/:streamtypecategories/:categoryid/cover

Path Parameters

Name
Type
Description

categoryid*

integer

the ID of a Category of the given Type of the calling Domain

streamtypecategories*

String

[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories]

Query Parameters

Name
Type
Description

url*

String

the URL to the Image, that should be used as Cover

description

String

an optional Description of the Cover

assetLanguage

String

if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover

copyright

String

an optional Copyright of the Cover

/:streamtypecategories/:categoryid/remove

DELETE https://api.nexx.cloud/v3.1/manage/:streamtypecategories/:categoryid/remove

Path Parameters

Name
Type
Description

streamtypecategories*

string

[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories]

categoryid*

integer

the ID of a Category of the given Type of the calling Domain

UploadLinks

UploadsLinks are dynamic URLs, that allow external Users to upload Files to a specific nexxOMNIA Account.

/uploadlinks/add

POST https://api.nexx.cloud/v3.1/manage/uploadlinks/add

Request Body

Name
Type
Description

title*

string

a Title for the new UploadLink

selectedStreamtypes*

string

a comma-seperated List of Streamtypes, that can be uploaded via this Link. Possible is [video, audio, image, file]

language*

string

a 2-Letter coded Language for the Frontend. Currently supported is [de, en, es, fr]

maxUsages

integer

if the UploadLink shall be restricted in Usage, use this Parameter for the maximal Number of Usages.

code

string

if desired, an optional code for further Protection of the Link.

useDomainStyle

boolean

if set to 1, the UploadLink UI will use the target Domain Colors and Icons.

askForNotes

boolean

if set to 1, the UploadLink will force the User to add some "Notes" as addiitonal Info for this Upload

/uploadlinks/:uploadlinkid/remove

DELETE https://api.nexx.cloud/v3.1/manage/uploadlinks/:uploadlinkid/remove

Path Parameters

Name
Type
Description

uploadlinkid

integer

the ID of an UploadLink of the calling Domain

PreviousMedia Export ManagementNextStatistics

Last updated 1 year ago

Was this helpful?