The first step for configuring your website is to get all information about the instance. Using your instace URL + /info.json (your_instance.eitvcloud.com/info.json), you can get all parameters of how your instance is configured at EiTV CLOUD.
We will use the following pattern to describe all features covered by our API:
First, we’ll describe the method and URL:
method: GET
URL: /info.json
Next, we have all parameters required for the method and all data that we’ll return:
PARAMETERS:
RETURN:
{
"page": "info",
"instance_info": {
"home": {
"status": “true”/”false”,
"title": "TITLE"
},
"video": {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"audio": {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"channel": {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"subchannel": {
"status": “false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"playlist": {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"event": {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"embed": {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"category": {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"community": {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"user_group": {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"guide": {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"archive": {
"status": "false",
"title": "TITLE",
"title_singular": "TITLE"
},
"page": {
"status": "false",
"title": "TITLE",
"title_singular": "TITLE"
},
"quiz": {
"status": "false",
"title": "TITLE",
"title_singular": "TITLE"
},
achievement: {
"status": "false",
"title": "TITLE",
"title_singular": "TITLE"
},
tvod: {
"status": "false",
"title": "TITLE",
"title_singular": "TITLE"
},
leaderboard: {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
donation: {
"status": "false",
"title": "TITLE",
"title_singular": "TITLE"
},
code: {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
payment_gateways: {
"status": “true”/”false”,
"title": "TITLE",
"title_singular": "TITLE"
},
"system_title": "TEXT",
"domain": "TEXT",
"tenant": "TEXT",
"unified_media": true/false,
"facebook_login": true/false,
"google_login": true/false,
"apple_login": true/false,
"gram_id_login": true/false,
"gram_id_login_url": "TEXT",
"ponte_id_login": true/false,
"ponte_id_login_url": "TEXT",
"user_profiles": true/false,
"user_create_public": true/false,
"user_create_email_verification": true/false,
"user_simultaneous_access": true/false,
"user_free_subscriptions_limit": NUMBER,
"user_cpf_required": true/false,
"user_international_id_required": true/false,
"app_login_screen": true/false, # Show Login on APP
"app_login_code": true/false,
"app_navigation_bar": true/false,
"app_navigation_bar_position": ["top"|"bottom"],
"app_search": true/false,
"app_search_category": true/false,
"app_search_channel": true/false,
"app_display_title": true/false,
"app_display_views": true/false,
"app_display_duration": true/false,
"app_display_created_at": true/false,
"app_display_progress": true/false,
"app_display_watch_later": true/false,
"app_watching_video_verification_interval": NUMBER, #Use '0' for disabled
"app_display_comments": true/false,
"app_display_rating": true/false,
"app_poster_title": true/false,
"app_poster_views": true/false,
"app_poster_duration": true/false,
"app_poster_created_at": true/false,
"app_poster_progress": true/false,
"app_poster_comments": true/false,
"app_poster_rating": true/false,
"app_download_resolution": ["240p"|"480p"|"720p"],
"app_download_expiration": NUMBER,
"app_download_limit": NUMBER,
"app_subscription_subscribe": true/false,
"app_iap_ios": true/false,
"color_header_bg": "COLOR HEX",
"color_header_font": "COLOR HEX",
"color_menu_bg": "COLOR HEX",
"color_menu_font": "COLOR HEX",
"color_body_bg": "COLOR HEX",
"color_body_font": "COLOR HEX",
"color_primary_bg": "COLOR HEX",
"color_primary_font": "COLOR HEX",
"signup_html_field": "TEXT",
"signin_html_field": "TEXT",
"player_views": true/false,
"player_share": true/false,
"player_date": true/false,
"player_progress": true/false,
"player_watermark": true/false,
"player_watermark_show": NUMBER,
"player_watermark_hide": NUMBER,
"login_username_title": "TEXT",
"login_password_title": "TEXT",
"subscription_preview": true/false,
"subscription_cancellation_quiz": "TEXT",
"time_zone_utc_offset": NUMBER,
"comment_moderation": true/false,
"achievement_enabled": true/false,
"achievement_certificate": true/false,
"achievement_display_leaderboard": true/false,
"achievement_display_blocked": true/false,
"menu_customization": true/false,
"menu_items": [{
"id": ID,
"menu_text": {
"en": "TEXT",
"pt": "TEXT",
"es": "TEXT"
},
"menu_type": "member|collection|url|label",
"menu_values": {
"member_type": "video|audio|event|embed|archive|page|quiz|playlist|category|channel|user_group"
"member_id": "ID"
"collection_type": "home|video|audio|event|embed|playlist|category|channel|user_group|guide|code"
"url": "URL"
},
"new_tab": true/false,
"navigation_bar": true/false,
"navigation_bar_text": {
"en": "TEXT",
"pt": "TEXT",
"es": "TEXT"
}, # or null
"position": NUMBER,
"url": "URL",
"thumb": "URL",
"available": true/false,
"parent_id": ID,
"children": [{
"MENU ITEM INFO"
}]
}],
"app_download": true/false,
"app_publishing_android": true/false,
"app_publishing_ios": true/false,
"app_smarttv_enabled": true/false,
"chromecast_enabled": true/false,
"chromecast_application_id": "TEXT",
"chromecast_test_application_id": "TEXT",
"subchannel_navigation": true/false,
"ga_tracking_id": "TEXT",
"google_tag_manager_id": "TEXT",
"terms_of_service": "TEXT",
"privacy_policy": "TEXT",
"user_limit": true/false,
"blocked": true/false,
"subscription_terms_of_service": "TEXT",
"language": ["en"|"pt"|"es"|"de"],
"video_api_keys": "TEXT",
"smarttv_config": {
"samsung_v1_version": "TEXT",
"samsung_v2_version": "TEXT",
"lg_v1_version": "TEXT",
"lg_v2_version": "TEXT",
"amazon_firetv_version": "TEXT",
"apple_tv_version": "TEXT",
"roku_version": "TEXT",
"android_tv_version": "TEXT"
},
"mobile_config": {
"android_mobile_version": "TEXT",
"ios_mobile_version": "TEXT"
},
"cached_guide_url": "TEXT",
"subscription_enabled": true/false,
"subscription_multiple": true/false,
"tvod_enabled": true/false,
"donation_enabled": true/false,
"subscription_type": "TEXT",
"subscription_currency_symbol": "TEXT",
"subscription_public_key": "TEXT",
"dtvplay_module": true/false,
"atsc_module": true/false,
"trickplay": true/false,
"parental_rating_display_position": "TEXT",
"drm": true/false,
"channel_engagement": true/false,
"environment_variables": [],
"user_extra_fields": [{
"cpf": {
"text": "TEXT",
"required": true/false
},
"address": {
"text": "TEXT",
"required": true/false
},
"address_2": {
"text": "TEXT",
"required": true/false
},
"district": {
"text": "TEXT",
"required": true/false
},
"zip_code": {
"text": "TEXT",
"required": true/false
},
"state": {
"text": "TEXT",
"required": true/false
},
"international_id": {
"text": "TEXT",
"required": true/false
}
]}
}
}
| << Previous topic | Next topic >> |
|---|
