Instance configuration

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"
    },
    "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"
    },
    "system_title": "TEXT",
    "domain": "TEXT",
    "terms_of_service": "TEXT",
    "unified_media": true/false,
    "facebook_login": true/false,
    "google_login": true/false,
    "user_create_public": 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_category": true/false,
    "app_search_channel": true/false,
    "app_display_views": true/false,
    "app_display_duration": true/false,
    "app_display_created_at": true/false,
    "app_display_comments": true/false,
    "app_display_rating": true/false,
    "app_download": 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,
    "app_publishing_android": true/false,
    "app_publishing_ios": true/false,
    "chromecast_enabled": true/false,
    "subchannel_navigation": true/false,
    "ga_tracking_id": "TEXT",
    "ad_tag_url": "TEXT",
    "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",
    "player_watermark": true/false,
    "subscription_enabled": true/false, 
    "subscription_multiple": true/false,  # Multiple Subscription Plan per User
    "subscription_type": ["iugu"|“stripe”], 
    "subscription_currency_symbol": ["R$"|”US$”], 
    "subscription_terms_of_service": "TEXT",
    "subscription_public_key": "TEXT", # Public key for subscription plans
    "subscription_preview": true/false,
    "subscription_cancellation_quiz": "QUIZ INFO",
    "tvod_enabled": true/false,
    "donation_enabled": true/false,
    "time_zone_utc_offset": NUMBER,
    "comment_moderation": true/false,
    "achievement_enabled": true/false,
    "achievement_certificate": 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"
      }]
    }],
    "language": ["en"|"pt"|“es”],
  }
}
<< Previous topic Next topic >>