Introduction

Niche Video Media's APIs belong to the Representational State Transfer (REST) category.They allow you to perform 'RESTful' operations such as reading, modifying, adding or deleting data from your Private Media Channel. Absorb the APIs to generate reports and brand from your own service. No more hassle of having to log into your Private Media Channel to generate lists or reports.

Getting Started

To generate the API key, log in to your Private Media Channel and go to General Settings > API Credential. Click on the "Enable API Access" button and then generate your API key by clicking on the Create/Update button. Once you have generated the key do not forget to hit "Save".

If you wish to regenerate your API key, all you have to do is click on the Create/Update button again to generate an updated API key.

You can then use this API key to identify the program called. Voila! You're all set to brand the Private Media Channel from your own service.

Authentication

You must use SSL (https instead of http) to access the API.

Send the API key through the UserCredential header with each request.

For Example:

curl --header "UserCredential: {'APIKey':'APIKeyValue','HostName':'ChannelURL'}" https://api.nichevid.com/user/list

Upload Video

To upload a media file from your computer, supply the required parameters and POST your media file to https://api.nichevid.com/video/upload as multipart-form encoded data.

The uploaded media will be visible immediately in your account, but may require processing.

For Example:

curl -H "UserCredential: {'APIKey':'APIKeyValue', 'HostName':'ChannelURL'}" -F communityid=< communityid > -F title=< videotitle > -F file=@< LOCAL_FILE_PATH > https://api.nichevid.com/video/upload

We expect a multipart/form-data POST to the server with file, communityid, and UserCredential parameters. Feel free to add additional parameters, such as title and desccription.

Response Format

application/json, text/json

Sample:
{
  "id": 1,
  "name": "Sample Video title",
  "type": "video",
  "created": "sample datetime string",
  "hashkey": "Hashed Value of ID",
  "communityid": "Community Video Belongs to"
}

Guest

Used to get the registration object for your channel. ex: Registration data

APIDescription
GET register Used to get the registration object for your channel, have to return this object with filled values to create new user from the API registration.
POST register/save No documentation available.

User

APIDescription
GET user/list?page={page}&pageSize={pageSize} Used to get the user list in your Private Media Channel.
GET user/{userid} No documentation available.
POST user/add Used to Create User in your Private Media Channel.

Relaitionship

APIDescription
POST relationship/add No documentation available.

Community

APIDescription
GET community/list?page={page}&pageSize={pageSize} Used to get the community list in your Private Media Channel.
GET community/{communityid} Used to get the information about the specified community

Content

APIDescription
GET content/{id} Used to get the individual Content information
GET content/list/{communityid}?page={page}&pageSize={pageSize} Used to get the List of contents in the specified community

Analytics

APIDescription
GET analytics/account Used to get the analytics in your Private Media Channel
GET analytics/community/{communityid} Used to get the analytics of the communities in your Private Media Channel
GET analytics/content/{contentid} Used to get the analytics of the content's usage in your Private Media Channel