Common Specification
List of APIs
The APIs are categorized into three groups as follows:
API Group Name | Description |
---|---|
Content Owner Media Unit Management API | Manages a resource or a list of resources of your Content Owner Media Unit. To use this API, you must be a member of the Content Owner Media Unit and authenticate your request by providing a valid access token that contains information about the Unit. |
Curator Media Unit Management API | Manages a resource or a list of resources of your Curator Media Unit. To use this API, you must be a member of the Curator Media Unit and authenticate your request by providing a valid access token that contains information about the Unit. |
Search API | API for searching 1) Stories created by Content Owner Media Units; 2) labels added to Stories all across Content Media Units; 3) events generated in connection with Stories or Content Owner Media Unit information across all Content Media Units. To use this API, authenticate your request by providing a valid access token. |
Search API
API Name | Overview |
---|---|
search/contentsholder/units.list | Retrieves a list of Content Owner Media Units |
search/contentsholder/posts.list | Retrieves a list of Stories across all Content Owner Media Units |
search/contentsholder/labels.list | Deprecated. Retrieves a list of labels added to Stories across all Content Owner Media Units |
search/contentsholder/postEvents.list | Retrieves a list of events generated in connection with Stories or Content Owner Media Unit information across all Content Owner Media Units |
Curator Media Unit Management API
API Name | Overview |
---|---|
curator/units.info | Retrieves information associated with your Curator Media Unit |
curator/curations.list | Retrieves a list of Curations in your Curator Media Unit |
curator/curations.info | Retrieves a Curation in your Curator Media Unit |
curator/curations.create | Creates a Curation in your Curator Media Unit |
curator/curations.update | Updates a Curation in your Curator Media Unit |
curator/curations.delete | Deletes a Curation in your Curator Media Unit |
curator/tags.list | Retrieves a list of tags added to Curations in your Curator Media Unit |
curator/tags.info | Retrieves information associated with a tag in your Curator Media Unit |
curator/tags.create | Creates a tag for Curations in your Curator Media Unit |
curator/tags.update | Updates a tag for Curations in your Curator Media Unit |
curator/tags.delete | Deletes a tag for Curations in your Curator Media Unit |
Content Owner Media Unit Management API
API Name | Overview |
---|---|
contentsholder/units.info | Retrieves information associated with your Content Owner Media Unit |
contentsholder/posts.list | Retrieves a list of Stories in your Content Owner Media Unit |
contentsholder/posts.info | Retrieves a Story in your Content Owner Media Unit |
contentsholder/posts.create | Creates a Story in your Content Owner Media Unit ( Markdown ) |
contentsholder/posts.update | Updates a Story in your Content Owner Media Unit |
contentsholder/posts.delete | Deletes a Story in your Content Owner Media Unit |
contentsholder/images.upload | Uploads an image in your Content Owner Media Unit゙ |
contentsholder/images.update | Updates an image in your Content Owner Media Unit |
contentsholder/images.delete | Deletes an image in your Content Owner Media Unit |
contentsholder/labels.list | Retrieves a list of labels added to Stories in your Content Owner Media Unit |
contentsholder/series.list | Retrieves a list of series added to Stories in your Content Owner Media Unit |
contentsholder/series.info | Retrieves information associated with a series in your Content Owner Media Unit |
contentsholder/series.create | Creates a series in your Content Owner Media Unit |
contentsholder/series.update | Updates a series in your Content Owner Media Unit |
contentsholder/series.delete | Deletes a series in your Content Owner Media Unit |
contentsholder/topics.list | Retrieves a list of topics added to Stories in your Content Owner Media Unit |
contentsholder/topics.info | Retrieves information associated with a topic in your Content Owner Media Unit |
contentsholder/topics.create | Creates a topic in your Content Owner Media Unit |
contentsholder/topics.update | Updates a topic in your Content Owner Media Unit |
contentsholder/topics.delete | Deletes a topic in your Content Owner Media Unit |
Objects
Listed below are the core objects you will find in the platform. Each object has an associated table describing the items in the object. Some items are labelled as “Y” (see the “In list API” column) signifying that the item will be returned in the list API responses. Non list APIs such as information APIs will return all the items in the responses.
API Name | Overview |
---|---|
“paging” object | A paging object contains information required for spreading retrieved items over a number of pages or sections |
“contentsholder unit” object | A “contentsholder unit” object contains Content Owner Media Unit information of your “contentsholde unit” |
“contentsholder post” object | A “contentsholder post” object contains Story information of your “contentsholder unit” |
“contentsholder image” object | A “contentsholder image” object contains image information of your “contentsholder unit” |
“contentsholder label” object | A “contentsholder label” object contains label information of your “contentsholder unit” |
“contentsholder series” object | A “contentsholder series” object contains series information of your “contentsholder unit” |
“contentsholder topic” object | A “contentsholder topic” object contains topic information of your “contentsholder unit” |
“curator unit” object | A “curator unit” object contains Curator Media Unit information of your “curator unit” |
“curator curation” object | A “curator curation” object contains Curation information of your “curator unit” |
“curator tag” object | A “curator tag” object contains tag information of your “curator unit” |
“search contentsholder unit” object | A “search contentsholder unit” object contains Content Owner Media Unit information of a “search contentsholder unit” |
“search contentsholder post” object | A “search contentsholder post” object contains Story information of the “search contentsholder unit” |
“search contentsholder label” object | A “search contentsholder label” object contains label information of the “search contentsholder unit” |