Client library for Hubhopper Partner Integration API(s) - Production
npm install --save @datafire/hubhopper
let hubhopper = require('@datafire/hubhopper').create({
api_key: "",
partner_id: ""
});
.then(data => {
console.log(data);
});
This is an interactive document explaining the API(s) that could be used to fetch data from Hubhopper. Use the api key provided to authorize x-api-key
and test the API(s). The output data models are also available for reference.
Get the list of all content categories.
hubhopper.categories.get({}, context)
- input
object
- pageSize
string
: Provide the size of the page to fetch. - page
string
: Provide the page number to fetch.
- pageSize
- output CategoryList
Get specific content category.
hubhopper.categories.categoryId.get({
"categoryId": ""
}, context)
- input
object
- categoryId required
string
: Unique qualifier for a category.
- categoryId required
- output SingleCategory
Get a list of all podcasts under a category.
hubhopper.categories.categoryId.podcasts.get({
"categoryId": ""
}, context)
- input
object
- categoryId required
string
: Unique qualifier for a category. - page
string
: Provide the page number to fetch. - pageSize
string
: Provide the size of the page to fetch. - order
string
: Order the items by 'newest' | 'random' - filters
string
: Takes filters like 'lang' in a url encoded json.
- categoryId required
- output PodcastList
Get the list of all podcasts.
hubhopper.podcasts.get({}, context)
- input
object
- page
string
: Provide the page number to fetch. - pageSize
string
: Provide the size of the page to fetch. - order
string
: Order the items by 'newest' | 'random' - filters
string
: Takes filters like 'lang' in a url encoded json.
- page
- output PodcastList
Get a single Podcast.
hubhopper.podcasts.podcastId.get({
"podcastId": ""
}, context)
- input
object
- podcastId required
string
: Unique qualifier for a podcast.
- podcastId required
- output SinglePodcast
Get a list of all episodes under a podcast.
hubhopper.podcasts.podcastId.episodes.get({
"podcastId": ""
}, context)
- input
object
- page
string
: Provide the page number to fetch. - pageSize
string
: Provide the size of the page to fetch. - order
string
: Order the items by 'newest' | 'random' - filters
string
: Takes filters like 'lang' in a url encoded json. - podcastId required
string
: Unique qualifier for a podcast.
- page
- output PodcastEpisodeList
hubhopper.util.languages.get({}, context)
- input
object
- pageSize
string
: Provide the size of the page to fetch. - page
string
: Provide the page number to fetch.
- pageSize
- output LanguageList
- CategoryListOutputModel
object
- categories
array
- noOfPages
integer
- page
integer
- pageSize
integer
- total
integer
- categories
- CategoryListCategoriesItem
object
- id
integer
- name
string
- url
string
- id
- Empty Schema
object
- Error Schema
object
- message
string
- message
- LanguageItem
object
- code
string
- id
integer
- name
string
- code
- LanguageList
object
- languages
array
- items LanguageItem
- noOfPages
integer
- page
integer
- pageSize
integer
- total
integer
- languages
- PodcastEpisodeListOutputModel
object
- episodes
array
- noOfPages
integer
- page
integer
- pageSize
integer
- total
integer
- episodes
- PodcastEpisodeListEpisodesItem
object
- author
string
- description
string
- episodeId
integer
- episodeUrl
string
- image
string
- isNew
boolean
- play
object
- duration
string
- durationInSec
integer
- size
string
- type
string
- url
string
- duration
- podcastId
integer
- podcastUrl
string
- publishTime
string
- publishedOn
integer
- title
string
- author
- PodcastListOutputModel
object
- noOfPages
integer
- page
integer
- pageSize
integer
- podcasts
array
- items PodcastListPodcastsItem
- total
integer
- noOfPages
- PodcastListPodcastsItem
object
- author
string
- category
object
- id
integer
- name
string
- id
- categoryId
integer
- description
string
- episodes
integer
- featured
object
- id
integer
- name
string
- id
- featuredId
integer
- image
string
- keywords
string
- latestEpisodeTime
string
- podcastId
integer
- title
string
- url
string
- author
- SingleCategoryOutputModel
object
: Model to fetch a single category.- category SingleCategoryCategory
- SingleCategoryCategory
object
- id
integer
- name
string
- url
string
- id
- SinglePodcastOutputModel
object
- podcast SinglePodcastPodcast
- SinglePodcastPodcast
object
- author
string
- category
object
- id
integer
- name
string
- id
- categoryId
integer
- description
string
- episodes
integer
- featured
object
- id
integer
- name
string
- id
- featuredId
integer
- image
string
- keywords
string
- latest_episode_time
string
- podcastId
integer
- title
string
- url
string
- website
string
- author