Customer Sign In

upLynk

Integration APIs: Owners

Overview

Use the Owners API to perform account management.

API Methods

The Owners API supports the following methods:

Method Description
/owners/linked/createCreates an Uplynk account whose billing is linked to your account.

Note: By default, this method is disabled. Please contact Technical Support to enable it.

/owners/linked/deleteDeletes an Uplynk account that was linked to your account via the /owners/linked/create method.

Note: By default, this method is disabled. Please contact Technical Support to enable it.

/owners/api-key/addAdds an API key.
/owners/api-key/updateUpdates an existing API key.
/owners/api-key/toggleToggles the status of an existing API key.
/owners/api-key/deleteDeletes an API key.

/owners/linked/create

Creates an Uplynk account that is linked to your account. The differences between a standard Uplynk account and a linked account are listed below.

  • All usage charges for a linked account will be billed to your account.
  • The user name associated with this linked account must be a unique ID that uses the following format:
    <Prefix><UserName>
    Sample Value: vectorgfx.jsmith
    The term "prefix" represents a value provided by Technical Support, while UserName is a custom alphanumeric value that identifies the user account.

Note: By default, this method is disabled. Please contact Technical Support to enable it.

Request body parameters are described below.

NameTypeDescription
usernamestringDefines the user name that will be assigned to the linked account being created.
passwordstringDefines the password that will be assigned to the linked account being created.

Do not use this password to authenticate a Live Slicer to your Uplynk account. Please use an API key instead. Leverage our API to generate an API key that only authorizes slicer-related actions by creating a sub-owner that has only been granted the "slice" permission.

contact_emailstringDefines the account owner's email address.

Response body parameters are described below.

NameTypeDescription
idstringIndicates the unique ID assigned to the linked account.
usernamestringIndicates the user name assigned to the linked account.
Example
1
2
3
4
5
Call('/api2/owners/linked/create', username='vectorgfx.jsmith', password='d$1129ea', contact_email='john.smith@example.com')
{
    "username" : "vectorgfx.jsmith",
    "id" : "2a020b444e4a4ecfab02101bfc5dfbe4"
}

/owners/linked/delete

Deletes a linked account that was created via the /owners/linked/create method.

Note: By default, this method is disabled. Please contact Technical Support to enable it.

Request body parameters are described below.

NameTypeDescription
idstringIdentifies the linked account to be deleted by its system-defined ID.
usernamestringIdentifies the linked account to be deleted by the user name associated with it.

Note: Please identify the account to be deleted using either the id or username parameter.

Response body parameters are described below.

NameTypeDescription
msgstringIndicates either an error message or it identifies the account that was deleted it by its system-defined ID.
errorintIndicates either an error code or 0 to indicate the account was successfully deleted.

Note: Account deletion may take time to complete. An account will be deleted regardless of whether the request to delete it times out prior to its completion.

Example
1
2
3
4
5
Call('/api2/owners/linked/delete', username='vectorgfx.jsmith')
{
    "msg" : "Erased account a735c56ea4014685bc74c0a375236cc5",
    "error" : 0
}

/owners/api-key/add

Generates an API key.

Note: An API key generated by this method is immediately available for use.

Response body parameters are described below.

NameTypeDescription
new_api_keystringIndicates the value assigned to the new API key.
errorintIndicates either an error code or 0 to indicate that the API key was created.
Example
1
2
3
4
5
Call('/api2/owners/api-key/add')
{
    "new_api_key" : "a735c56ea4014685bc74c0a375236cc5"
    "error" : 0
}

/owners/api-key/update

Updates the API key associated with an account.

Note: This update action will immediately invalidate the current API key and replace it with a new one. Any tokenized playback URLs generated with the previous key will be immediately invalidated.

Request body parameters are described below.

NameTypeDescription
api_keystringIdentifies the API key that will be updated.

Response body parameters are described below.

NameTypeDescription
api_keystringIndicates the value assigned to the updated API key.
errorintIndicates either an error code or 0 to indicate the API key was updated.
Example
1
2
3
4
5
Call('/api2/owners/api-key/update', api_key='b846d67fb5125796cd85d1b486347dd6')
{
    "api_key" : "a735c56ea4014685bc74c0a375236cc5",
    "error" : 0
}

/owners/api-key/toggle

Updates the status of an API key.

Note: Status changes take place immediately. Disabing a key will also invalidate any tokenized playback URLs generated by that key.

Request body parameters are described below.

NameTypeDescription
key_to_togglestringIdentifies the API key whose status will be toggled.
is_enabledBooleanDefines the status of the API key.
Valid values are:
  • True: Sets the API key's status to enabled.
  • False: Sets the API key's status to disabled.

Note: Passing an invalid value for this parameter will disable the specified API key.

Response body parameters are described below.

NameTypeDescription
key_toggledstringIndicates the API key whose status was changed.
is_enabledBooleanIndicates the status applied to the API key.
Valid values are:
  • True: Indicates that the API key was enabled.
  • False: Indicates that the API key was disabled.
errorintIndicates either an error code or 0 to indicate the API key's status was updated.
Example
1
2
3
4
5
6
Call('/api2/owners/api-key/update', key_to_toggle='a735c56ea4014685bc74c0a375236cc5', is_enabled=False)
{
    "key_toggled" : "a735c56ea4014685bc74c0a375236cc5",
    "is_enabled" : False,
    "error" : 0
}

/owners/api-key/delete

Deletes an API key.

Note: Deleting an API key takes effect immediately. Any tokenized playback URLs generated with this key will be immediately invalidated.

Request body parameters are described below.

NameTypeDescription
key_to_deletestringIdentifies the API key to be deleted.

Response body parameters are described below.

NameTypeDescription
errorintIndicates either an error code or 0 to indicate the API key's status was deleted.
Example
1
2
3
4
Call('/api2/owners/api-key/update', key_to_delete='b846d67fb5125796cd85d1b486347dd6')
{
    "error" : 0
}