NAV Navbar
Logo
cURL Ruby Python PHP Java Node Go .NET HTTPie
  • Introduction
  • Authentication
  • Request Body
  • Errors
  • Pagination
  • Request IDs
  • Video
  • Categorization
  • Storage
  • Live Streaming
  • Callback
  • User Management
  • Embed Metadata
  • Change log
  • Introduction

    API libraries

    # Base URL
    https://api.uiza.io/api/public/v4
    

    Install

    gem install uiza
    
    pip install uiza
    
    composer require uiza/uiza-php
    
    <dependency>
      <groupId>io.uiza</groupId>
      <artifactId>uiza-java</artifactId>
      <version>1.2.0</version>
    </dependency>
    
    npm install uiza --save
    
    go get -u github.com/uizaio/api-wrapper-go
    
    nuget install Uiza
    

    This website documents the public API for Uiza version 4.0

    The Uiza APIs are HTTP-based RESTful APIs. Our API has predictable, resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses HTTP response codes, authentication, verbs.

    Important: You cannot run the sample requests in this guide as-is. Replace call-specific parameters such as tokens and AppIDs with your own values.

    Was this section helpful? Yes No

    Authentication

    REQUEST

    curl 'https://api.uiza.io/api/public/v4/api/public/v4/media/entity?appId=b2a3e6307dcf421a8a455825c01de914&id=78e8ed17-54fd-462d-89f1-e4732dafa348' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -D "-" \
      -X GET
    # The colon prevents curl from asking for a password.
    

    To test requests using your account, replace the sample API key with your actual API key.

    The Uiza API uses API Key to authenticate requests. You can view and manage your API Keys in the Uiza Dashboard.

    Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

    Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.

    If you need to authenticate via bearer auth (e.g., for a cross-origin request), use -H "Authorization: Bearer uap-5126204af4ee487f9c295525f03b9268-353340ef" instead of -u uap-5126204af4ee487f9c295525f03b9268-353340ef.

    All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

    Was this section helpful? Yes No

    Get API key

    After logging in to your organization, you can get your own API key in the APPLICATION SETTING section

    Go to APPLICATION SETTING, section Publish API

    alt text

    Then you can create your own API key.

    alt text

    alt text

    This key can be used for calling Uiza's API.

    Was this section helpful? Yes No

    Request Body

    Base URL

    curl 'https://api.uiza.io/api/public/v4/api/public/v4/media/entity?appId=b2a3e6307dcf421a8a455825c01de914&id=78e8ed17-54fd-462d-89f1-e4732dafa348' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -D "-" \
      -X GET
    

    Uiza API accepts request arguments in form of JSON-Object in HTTP request body.

    Was this section helpful? Yes No

    Errors

    Uiza uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Uiza's servers (these are rare).

    Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.

    HTTP status code summary

    Error Code Detail
    200 - OK Everything worked as expected.
    400 - Bad Request The request was unacceptable, often due to missing a required parameter.
    401 - Unauthorized No valid API key provided.
    404 - Not Found The requested resource doesn't exist.
    422 - Unprocessable The syntax of the request is correct (often cause of wrong parameter)
    500, 502, 503, 504 - Server Errors Something went wrong on Uiza's end. (These are rare.)

    Was this section helpful? Yes No

    Pagination

    All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list entities, list categories, and list invoices. These list API methods share a common structure, taking at least these three parameters: limit, page.

    LIST RESPONSE FORMAT

    Attribute Type Description
    data string An array containing the actual response elements, paginated by any request parameters.
    metadata string Contains total as total number of data without pagination, result as number of paginated data, page as current page, limit as how many records each array of data contain.

    Was this section helpful? Yes No

    Request IDs

    Base URL

    curl 'https://api.uiza.io/api/public/v4/api/public/v4/media/entity?appId=b2a3e6307dcf421a8a455825c01de914&id=78e8ed17-54fd-462d-89f1-e4732dafa348' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -D "-" \
      -X GET
    

    Each API request has an associated request identifier. You can find this value in the response headers, under u-request-id (Uiza's Request ID). If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.

    Was this section helpful? Yes No

    Video

    ENDPOINTS

    POST /media/entity
    GET /media/entity?id=:entity_id
    PUT /media/entity?id=:entity_id
    DELETE /media/entity?id=:entity_id
    GET /media/entity
    

    We call videos as Entity. You can create entities by uploading using HTTP, FTP, hyper links, S3 links. The API allows you to create, delete, and update entities. You can retrieve individual entities as well as a list of all your entities.

    All entities need to be published before the public can access. Unpublished videos can still be edited, listed by API or using Dashboard but Player will not play.

    Was this section helpful? Yes No

    The entity object

    {
      "id": "16ab25d3-fd0f-4568-8aa0-0339bbfd674f",
      "name": "The Evolution of Dance",
      "description": "Judson Laipply did a fantastic job in performing various dance moves",
      "shortDescription": "How good a dancer can you be?",
      "view": 0,
      "poster": "https://sample-videos.com/img/Sample-jpg-image-200kb.jpg",
      "thumbnail": "https://sample-videos.com/img/Sample-jpg-image-200kb.jpg",
      "type": "vod",
      "status": 1,
      "duration": "237.865215",
      "publishToCdn":"success",
      "metadataId": "16a9e425-efb0-4360-bd92-8d49da111e88",
      "embedMetadata": {
          "artist": "John Doe",
          "album": "Album sample",
          "genre": "Pop"
      },
      "extendMetadata": {
          "movie_category":"action",
          "imdb_score":8.8,
          "published_year":"2018"
      },
      "createdAt": "2018-06-16T18:54:15.000Z",
      "updatedAt": "2018-06-16T18:54:29.000Z"
    }
    

    Attributes

    Attribute Description
    id string Unique identifier for the object.
    name string The video's name, meant to be displayable to end users.
    url text URL of media file (HTTP/HTTPS, FTP, S3). Send empty string if you upload with SDK
    inputType enum Type of URL (Acceptable values: [ http|s3|ftp|s3-uiza ] ). If URL is empty, this attribute must be s3-uiza
    description text The video's description, meant to be displayable to end users. Can contain up to 65,535 characters.
    shortDescription text The video's short description, meant to be displayable to end users. Can contain up to 250 characters.
    metadataId array MetadataID is Category ID
    poster string The video's poster URL, meant to be displayable to end users.
    thumbnail string The video's thumbnail URL, meant to be displayable to end users.
    type enum Has 2 types: VOD and AOD
    VOD stand for Video On Demand. AOD stand for Audio On Demand.
    duration string Duration of entity in seconds. Measured up to oneth million of a second.
    metadataIds array A list of categories of this entity.
    view number Total times this entity has been viewed.
    publishToCdn string Status of published task, possible values are [ queue, not-ready, success, failed ]
    extendMetadata object A set of key-value pairs that you can attach to a video object, meant to be displayable to end users.
    embedMetadata object A set of predefined key-value pairs that you can attach to a video object, meant to be displayable to end users. See Embed Metadata.
    createdAt datetime The time at which the entity was created. The format is ISO 8601.
    updatedAt datetime The time at which the entity was last edited. The format is ISO 8601.

    Was this section helpful? Yes No

    Create entity

    REQUEST

    curl -X POST \
      'https://api.uiza.io/api/public/v4/media/entity' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "name": "The Evolution of Dance",
        "url": "https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_10mb.mp4",
        "inputType": "http",
        "description": "Judson Laipply did a fantastic job in performing various dance moves",
        "shortDescription": "How good a dancer can you be?",
        "poster": "https://sample-videos.com/img/Sample-jpg-image-200kb.jpg",
        "thumbnail": "https://sample-videos.com/img/Sample-jpg-image-200kb.jpg",
        "metadataId": "16a9e425-efb0-4360-bd92-8d49da111e88",
        "extendMetadata": {
            "movie_category":"action",
            "imdb_score":8.8,
            "published_year":"2018"
        },
        "embedMetadata": {
            "artist":"John Doe",
            "album":"Album sample",
            "genre":"Pop"
        },
        "metadataIds":["16a9e425-efb0-4360-bd92-8d49da111e88"]
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      name: "The Evolution of Dance",
      url: "https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_10mb.mp4",
      inputType: "http",
      description: "Judson Laipply did a fantastic job in performing various dance moves",
      shortDescription: "How good a dancer can you be?"
    }
    
    begin
      entity = Uiza::Entity.create params
      puts entity.id
      puts entity.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.entity import Entity
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    entity_data = {
      "name": "The Evolution of Dance",
      "url": "https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_10mb.mp4",
      "inputType": "http",
      "description": "Judson Laipply did a fantastic job in performing various dance moves",
      "shortDescription": "How good a dancer can you be?"
    }
    
    try:
      res, status_code = Entity().create(**entity_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "name" => "The Evolution of Dance",
      "url" => "https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_10mb.mp4",
      "inputType" => "http",
      "description" => "Judson Laipply did a fantastic job in performing various dance moves",
      "shortDescription" => "How good a dancer can you be?"
    ];
    
    try {
      $entity = Uiza\Entity::create($params);
    
      print_r($entity);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
     ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Entity;
    import io.uiza.model.Entity.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("name", "The Evolution of Dance");
        params.put("url", "https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_10mb.mp4");
        params.put("inputType", InputType.HTTP.toString());
        params.put("description", "Judson Laipply did a fantastic job in performing various dance moves");
        params.put("shortDescription", "How good a dancer can you be?");
    
        try {
          JsonObject response = Entity.create(params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'name': 'The Evolution of Dance',
      'url': 'https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_10mb.mp4',
      'inputType': 'http',
      'description': 'Judson Laipply did a fantastic job in performing various dance moves',
      'shortDescription': 'How good a dancer can you be?'
    };
    
    uiza.entity.create(params)
      .then((res) => {
        //Identifier of entity has been created
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/entity"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params :=  &uiza.EntityCreateParams{
      Name: uiza.String("The Evolution of Dance"),
      URL: uiza.String("https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_10mb.mp4"),
      InputType: uiza.String("http"),
      Description: uiza.String("Judson Laipply did a fantastic job in performing various dance moves"),
      ShortDescription: uiza.String("How good a dancer can you be?")
    }
    
    response, err := entity.Create(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Entity.Create(new CreateEntityParameter()
      {
        Name = "The Evolution of Dance",
        InputType = "http",
        Description = "Judson Laipply did a fantastic job in performing various dance moves",
        ShortDescription = "How good a dancer can you be?",
        URL = "https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_10mb.mp4"
      });
      Console.WriteLine(string.Format("Create New Entity Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Entities can be created with the following types of link: HTTP, FTP, S3.

    With S3 URL, it must be public accessible.
    

    RESPONSE

    {
      "id": "c1a842ca-e266-4b3c-bc33-13dd9354d90a"
    }
    

    HTTP Request

    POST https://api.uiza.io/api/public/v4/media/entity

    Entity Object

    Attribute Description Required
    name string The video's name, meant to be displayable to end users. Yes
    url text URL of media file (HTTP/HTTPS, FTP, S3). Send empty string if you upload with SDK Yes
    inputType enum Type of URL (Acceptable values: [ http|s3|ftp|s3-uiza ] ). If URL is empty, this attribute must be s3-uiza Yes
    description text The video's description, meant to be displayable to end users. Can contain up to 65,535 characters.
    shortDescription text The video's short description, meant to be displayable to end users. Can contain up to 250 characters.
    metadataId array MetadataID is Category ID
    poster string The video's poster URL, meant to be displayable to end users.
    thumbnail string The video's thumbnail URL, meant to be displayable to end users.
    metadataIds array A list of categories for this entity.
    extendMetadata object A set of key-value pairs that you can attach to a video object, meant to be displayable to end users.
    embedMetadata object A set of predefined key-value pairs that you can attach to a video object, meant to be displayable to end users. See Embed Metadata.

    RETURNS

    Returns an entity id if the call succeeded.

    Parameter Type Description
    id string The identifier of the created entity.

    If you want to integrate with Uiza using AWS sdk to upload files to Uiza's storage. Please leave `URL` attribute **empty** and use `s3-uiza` for inputType attribute

    Was this section helpful? Yes No

    Retrieve an entity

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/media/entity?id=b55a899e-4c40-44ed-96c1-c767227366f4' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      entity = Uiza::Entity.retrieve "b55a899e-4c40-44ed-96c1-c767227366f4"
      puts entity.id
      puts entity.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.entity import Entity
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Entity().retrieve(id="b55a899e-4c40-44ed-96c1-c767227366f4")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $entity = Uiza\Entity::retrieve("b55a899e-4c40-44ed-96c1-c767227366f4");
    
      print_r($entity);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
     ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Entity;
    import io.uiza.model.Entity.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Entity.retrieve("b55a899e-4c40-44ed-96c1-c767227366f4");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': 'b55a899e-4c40-44ed-96c1-c767227366f4'
    };
    
    
    uiza.entity.retrieve(params)
      .then((res) => {
        //Identifier of entity
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/entity"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.EntityRetrieveParams{ID: uiza.String("b55a899e-4c40-44ed-96c1-c767227366f4")}
    response, err := entity.Retrieve(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Entity.Retrieve("b55a899e-4c40-44ed-96c1-c767227366f4");
    
      Console.WriteLine(string.Format("Get Entity Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Retrieves the details of an existing entity. Supply the unique entity ID from either an entity creation request or the entity list, and Uiza will return the corresponding entity information.

    RESPONSE

    {
      "id": "b55a899e-4c40-44ed-96c1-c767227366f4",
      "name": "The Evolution of Dance",
      "description": "Judson Laipply did a fantastic job in performing various dance moves",
      "shortDescription": "How good a dancer can you be?",
      "view": 0,
      "poster": "https://sample-videos.com/img/Sample-jpg-image-200kb.jpg",
      "thumbnail": "https://sample-videos.com/img/Sample-jpg-image-200kb.jpg",
      "type": "vod",
      "status": 1,
      "duration": "237.865215",
      "publishToCdn":"success",
      "metadataId": "16a9e425-efb0-4360-bd92-8d49da111e88",
      "embedMetadata": {
          "artist": "John Doe",
          "album": "Album sample",
          "genre": "Pop"
      },
      "extendMetadata": {
          "movie_category":"action",
          "imdb_score":8.8,
          "published_year":"2018"
      },
      "createdAt": "2018-06-16T18:54:15.000Z",
      "updatedAt": "2018-06-16T18:54:29.000Z"
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/media/entity?id=16ab25d3-fd0f-4568-8aa0-0339bbfd674f

    ARGUMENTS

    Parameter Type Description Required
    id string The identifier of the video to be retrieved. Yes

    RETURNS

    Returns a entity object if a valid identifier was provided.

    Was this section helpful? Yes No

    List entities

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/media/entity' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      entities = Uiza::Entity.list
      puts entities.first.id
      puts entities.first.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.entity import Entity
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Entity().list(name="Title")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $entities = Uiza\Entity::list();
    
      print_r($entities);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Entity;
    import io.uiza.model.Entity.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonArray response = Entity.list();
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    uiza.entity.list()
      .then((res) => {
        //Get list of entities including all detail.
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/entity"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.EntityListParams{}
    listEntity, err := entity.List(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Entity.List();
    
      Console.WriteLine(string.Format("Get Entity List Success, total record {0}", result.MetaData.result));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Returns a list of entities. The entities are returned sorted by creation date, with the most recent entities appearing first.

    RESPONSE

    {
        "data": [
            {
                "id": "42ceb1ab-18ef-4f2e-b076-14299756d182",
                "name": "Sample Video 1",
                "description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
                "shortDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry",
                "view": 0,
                "poster": "https://example.com/picture001",
                "thumbnail": "https://example.com/picture002",
                "type": "vod",
                "duration": "237.865215",
                "publishToCdn":"success",
                "embedMetadata": {
                    "artist": "John Doe",
                    "album": "Album sample",
                    "genre": "Pop"
                },
                "extendMetadata": {
                    "movie_category":"action",
                    "imdb_score":8.8,
                    "published_year":"2018"
                },
                "createdAt": "2018-06-22T19:20:17.000Z",
                "updatedAt": "2018-06-22T19:20:17.000Z"
            },
            {
                "id": "64b15996-2261-4f41-a3c4-72b652323f67",
                "name": "Sample Video 2",
                "description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
                "shortDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry",
                "view": 0,
                "poster": "https://example.com/picture001",
                "thumbnail": "https://example.com/picture002",
                "type": "vod",
                "duration": "178.178105",
                "publishToCdn":"success",
                "embedMetadata": {
                    "artist": "John Doe",
                    "album": "Album sample",
                    "genre": "Pop"
                },
                "extendMetadata": {
                    "movie_category":"action",
                    "imdb_score":8.8,
                    "published_year":"2018"
                },
                "createdAt": "2018-06-22T19:16:22.000Z",
                "updatedAt": "2018-06-22T19:16:22.000Z"
            }
        ],
        "metadata": {
            "total": 2,
            "result": 2,
            "page": 1,
            "limit": 20
        }
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/media/entity

    ARGUMENTS

    Parameter Type Description Required
    publishToCdn string Status of publish task, include [ queue, not-ready, success, failed ] No
    metadataId string Get all entity in folder/playlist No

    RETURNS

    A dictionary with a data property that contains an array of up to limit entities, starting after entity page. Each entry in the array is a separate entity object. If no more entities are available, the resulting array will be empty. This request should never return an error.

    Was this section helpful? Yes No

    Update an entity

    REQUEST

    curl -X PUT \
      'https://api.uiza.io/api/public/v4/media/entity' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "b55a899e-4c40-44ed-96c1-c767227366f4",
        "name": "The Evolution of Dance 2",
        "description": "Judson Laipply did it again with a fantastic job in performing better dance moves",
        "shortDescription":"You can never be as good a dancer as Judson Laipply.",
        "poster": "https://sample-videos.com/img/Sample-jpg-image-200kb.jpg",
        "thumbnail": "https://sample-videos.com/img/Sample-jpg-image-200kb.jpg",
        "extendMetadata":{
            "movie_category":"action",
            "imdb_score":8.8,
            "published_year":"2018"
        }
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      id: "b55a899e-4c40-44ed-96c1-c767227366f4",
      name: "The Evolution of Dance 2",
      description: "Judson Laipply did it again with a fantastic job in performing better dance moves"
    }
    
    begin
      entity = Uiza::Entity.update params
      puts entity.id
      puts entity.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.entity import Entity
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    entity_data = {
      "id": "b55a899e-4c40-44ed-96c1-c767227366f4",
      "name": "The Evolution of Dance 2",
      "description": "Judson Laipply did it again with a fantastic job in performing better dance moves"
    }
    
    try:
      res, status_code = Entity().update(**entity_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "name" => "The Evolution of Dance 2",
      "description" => "Judson Laipply did it again with a fantastic job in performing better dance moves"
    ];
    
    try {
      $entity = Uiza\Entity::update("b55a899e-4c40-44ed-96c1-c767227366f4", $params);
    
      print_r($entity);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Entity;
    import io.uiza.model.Entity.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("name", "The Evolution of Dance 2");
        params.put("description", "Judson Laipply did it again with a fantastic job in performing better dance moves");
    
        try {
          JsonObject response = Entity.update("b55a899e-4c40-44ed-96c1-c767227366f4", params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': 'b55a899e-4c40-44ed-96c1-c767227366f4',
      'name': 'The Evolution of Dance 2',
      'description': 'Judson Laipply did it again with a fantastic job in performing better dance moves'
    };
    
    uiza.entity.update(params)
      .then((res) => {
        // Identifier of entity has been updated
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/entity"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.EntityUpdateParams{
      ID: uiza.String("b55a899e-4c40-44ed-96c1-c767227366f4"),
      Name: uiza.String("The Evolution of Dance 2"),
      Description: uiza.String("Judson Laipply did it again with a fantastic job in performing better dance moves"),
    }
    response, err := entity.Update(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Entity.Update(new UpdateEntityParameter()
      {
        Id = "b55a899e-4c40-44ed-96c1-c767227366f4",
        Name = "The Evolution of Dance 2",
        Description = "Judson Laipply did it again with a fantastic job in performing better dance moves"
      });
    
      Console.WriteLine(string.Format("Update Entity Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Updates the specified entity by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the name parameter, that becomes the entity’s new name. This request accepts mostly the same arguments as the entity creation call.

    RESPONSE

    {
      "id": "b55a899e-4c40-44ed-96c1-c767227366f4"
    }
    

    HTTP Request

    PUT https://api.uiza.io/api/public/v4/media/entity

    RETURNS

    Returns the entity id if the update succeeded. Returns an error if update parameters are invalid (e.g. specifying an invalid inputType or an invalid metadataId).

    Was this section helpful? Yes No

    Delete an entity

    REQUEST

    curl -X DELETE \
      'https://api.uiza.io/api/public/v4/media/entity' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "8da31fbe-e2b5-485b-8fa7-cabfcc5ac2ba"
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::Entity.delete "8da31fbe-e2b5-485b-8fa7-cabfcc5ac2ba"
      puts response.id
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.entity import Entity
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Entity().delete(id="8da31fbe-e2b5-485b-8fa7-cabfcc5ac2ba")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $response = Uiza\Entity::delete("8da31fbe-e2b5-485b-8fa7-cabfcc5ac2ba");
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Entity;
    import io.uiza.model.Entity.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Entity.delete("8da31fbe-e2b5-485b-8fa7-cabfcc5ac2ba");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '8da31fbe-e2b5-485b-8fa7-cabfcc5ac2ba'
    };
    
    uiza.entity.delete(params)
      .then((res) => {
        // Identifier of entity has been deleted
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/entity"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.EntityDeleteParams{ID: uiza.String("8da31fbe-e2b5-485b-8fa7-cabfcc5ac2ba")}
    response, err := entity.Delete(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Entity.Delete("8da31fbe-e2b5-485b-8fa7-cabfcc5ac2ba");
    
      Console.WriteLine(string.Format("Delete Entity Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Permanently deletes a entity. It cannot be undone.

    RESPONSE

    {
      "id": "8da31fbe-e2b5-485b-8fa7-cabfcc5ac2ba"
    }
    

    HTTP Request

    DELETE https://api.uiza.io/api/public/v4/media/entity

    ARGUMENTS

    Parameter Type Description Required
    id string The identifier of the entity to be deleted. Yes

    RETURNS

    Returns an id with a deleted parameter on success. If the entity ID does not exist, this call returns an error.

    Parameter Type Description
    id string Identifier of entity has been deleted

    Was this section helpful? Yes No

    Search entity

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/media/entity/search?keyword=dance' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      entities = Uiza::Entity.search "dance"
      puts entities.first.id
      puts entities.first.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.entity import Entity
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Entity().search(keyword="dance")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $entities = Uiza\Entity::search(["keyword" => "dance"]);
    
      print_r($entities);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Entity;
    import io.uiza.model.Entity.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonArray response = Entity.search("dance");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'keyword': 'dance'
    };
    
    uiza.entity.search(params)
      .then((res) => {
        // Response search entity base on keyword entered
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/entity"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.EntitySearchParams{Keyword: uiza.String("dance")}
    response, err := entity.Search(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Entity.Search("dance");
    
      Console.WriteLine(string.Format("Search Success, total record {0}", result.Data.Count));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Search for entities having name that match keyword

    RESPONSE

    {
      "data": [
        {
          "id": "16ab25d3-fd0f-4568-8aa0-0339bbfd674f",
          "name": "Sample Video 001",
          "description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
          "shortDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry",
          "view": 0,
          "poster": "https://example.com/picture001",
          "thumbnail": "https://example.com/picture002",
          "type": "vod",
          "status": 1,
          "duration": "237.865215",
          "publishToCdn":"success",
          "embedMetadata": {
              "artist": "John Doe",
              "album": "Album sample",
              "genre": "Pop"
          },
          "extendMetadata": {
              "movie_category":"action",
              "imdb_score":8.8,
              "published_year":"2018"
          },
          "createdAt": "2018-06-16T18:54:15.000Z",
          "updatedAt": "2018-06-16T18:54:29.000Z"
        },
        {
          "id": "16ab25d3-fd0f-4568-8aa0-0339bbfd674f",
          "name": "Sample video test",
          "description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
          "shortDescription": "Lorem Ipsum is simply dummy text of the printing and typesetting industry",
          "view": 0,
          "poster": "https://example.com/picture003",
          "thumbnail": "https://example.com/picture004",
          "type": "vod",
          "status": 1,
          "duration": "178.178105",
          "publishToCdn":"success",
          "embedMetadata": {
              "artist": "Jane Roe",
              "album": "Album global 3",
              "genre": "Country"
          },
          "extendMetadata": {
              "movie_category":"action",
              "imdb_score":8.8,
              "published_year":"2018"
          },
          "createdAt": "2018-06-16T18:54:15.000Z",
          "updatedAt": "2018-06-16T18:54:29.000Z"
        }
      ],
      "metadata": {
          "total": 2,
          "result": 2,
          "page": 1,
          "limit": 20
      }
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/media/entity/search

    Argument

    Parameter Description Required
    keyword string Keyword to search for Yes

    RETURNS

    A dictionary with a data property that contains an array of up to limit entities, starting after entity page. Each entry in the array is a separate entity object. If no more entities are available, the resulting array will be empty. This request should never return an error.

    Was this section helpful? Yes No

    Publish entity to CDN

    REQUEST

    curl -X POST \
      'https://api.uiza.io/api/public/v4/media/entity/publish' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "c1a842ca-e266-4b3c-bc33-13dd9354d90a"
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::Entity.publish "c1a842ca-e266-4b3c-bc33-13dd9354d90a"
      puts response.message
      puts response.entityId
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.entity import Entity
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Entity().publish(id="c1a842ca-e266-4b3c-bc33-13dd9354d90a")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $response = Uiza\Entity::publish(["id" => "c1a842ca-e266-4b3c-bc33-13dd9354d90a"]);
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Entity;
    import io.uiza.model.Entity.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Entity.publish("c1a842ca-e266-4b3c-bc33-13dd9354d90a");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': 'c1a842ca-e266-4b3c-bc33-13dd9354d90a'
    };
    
    uiza.entity.publish(params)
      .then((res) => {
        // Identifier of task publish
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/entity"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.EntityPublishParams{ID: uiza.String("c1a842ca-e266-4b3c-bc33-13dd9354d90a")}
    response, err := entity.Publish(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Entity.Publish("c1a842ca-e266-4b3c-bc33-13dd9354d90a");
    
      Console.WriteLine(string.Format("Publish Entity Success : entityId = {0} ", result.Data.entityId));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    All entities need to be published before the public can access. Unpublished videos can still be edited, listed by API or using Dashboard but Player will not play.

    If you use Uiza's `Quick Start` on App's dashboard it will get published automatically.

    RESPONSE

    {
      "id": "c1a842ca-e266-4b3c-bc33-13dd9354d90a",
      "message": "Your entity started publish, check process status with this entity ID",
      "entityId": "42ceb1ab-18ef-4f2e-b076-14299756d182"
    }
    

    HTTP Request

    POST https://api.uiza.io/api/public/v4/media/entity/publish

    ARGUMENTS

    Parameter Description Required
    id string Identifier of entity Yes

    RETURNS

    Return an identifier of the publishing request. Use id to retrieve publishing status. The publishing process should take a few minutes to complete, varies by video's size and length.

    Attribute Description
    id string The identifier of the publishing request
    message string Detail message of the publishing request
    entityId string The identifier of entity

    Was this section helpful? Yes No

    Get publish status

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/media/entity/publish/status' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "c1a842ca-e266-4b3c-bc33-13dd9354d90a"
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::Entity.get_status_publish "c1a842ca-e266-4b3c-bc33-13dd9354d90a"
      puts response.progress
      puts response.status
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.entity import Entity
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Entity().get_status_publish(id="c1a842ca-e266-4b3c-bc33-13dd9354d90a")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $response = Uiza\Entity::getStatusPublish("c1a842ca-e266-4b3c-bc33-13dd9354d90a");
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Entity;
    import io.uiza.model.Entity.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Entity.getStatusPublish("c1a842ca-e266-4b3c-bc33-13dd9354d90a");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': 'c1a842ca-e266-4b3c-bc33-13dd9354d90a'
    };
    
    uiza.entity.get_status_publish(params)
      .then((res) => {
        //Progress of task publish, will be success when reach 100
        // Status of task publish (processing, success, error)
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/entity"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.EntityPublishParams{ID: uiza.String("c1a842ca-e266-4b3c-bc33-13dd9354d90a")}
    response, err := entity.GetStatusPublish(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Entity.GetStatusPublish("c1a842ca-e266-4b3c-bc33-13dd9354d90a");
    
      Console.WriteLine(string.Format("Get Status Publish Success : temp_access_id = {0} ", result.Data.status));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Checks progress of a publishing request. You need only supply the unique publishing identifier that was returned upon publishing entity request.

    RESPONSE

    {
      "progress": 0,
      "status": "processing"
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/media/entity/publish/status

    ARGUMENTS

    Parameter Description Required
    id string The identifier of the task received from publish API Yes

    RETURNS

    Return progress and status of the publishing task if a valid identifier was provided. A successful task will have progress equals 100 (percent) and success as status.

    Parameter Description
    progress number Progress of the task publish, in percentage
    status string Status of task publish (processing, success, error)

    Was this section helpful? Yes No

    Get AWS upload key

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/admin/app/config/aws' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::Entity.get_aws_upload_key
      puts response.bucket_name
      puts response.region_name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.entity import Entity
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Entity().get_aws_upload_key()
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $response = Uiza\Entity::getAWSUploadKey();
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Entity;
    import io.uiza.model.Entity.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Entity.getAwsUploadKey();
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    uiza.entity.get_aws_upload_key()
      .then((res) => {
        // The response body will return you the paramaters that used for input to aws sdk , then upload your files to Uiza’s storage
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/entity"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    response, err := entity.GetAWSUploadKey()
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Entity.GetAWSUploadKey();
    
      Console.WriteLine(string.Format("Get AWS Upload Key Success : temp_access_id = {0} ", result.Data.temp_access_id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Videos can be uploaded in builk to AWS S3. Uiza provides a temporary S3 bucket on AWS for you to upload videos to. Each organization may have one temporary bucket at a time.

    Infomation on how to use AWS SDK: - Nodejs - PHP - Python - Ruby

    RESPONSE

    {
      "temp_expire_at": 1533658598,
      "temp_access_id": "ASIAV*******GPHO2DTZ",
      "bucket_name": "uiza****-storage-ap-southeast-1-01/upload-temp/****ff4ad74a5195f4c/",
      "temp_session_token": "FQoGZXIvYXdzEKb//////////wEaDM3rrospIPdBVVULUiKQBHd6H6CNOlRc+xBXDa3Nw8gEymmC/XjDYjIScgx9wJ4QBWwQPwizxLn4AdoLgnYAXVfuGZgOVB6KLHlUZ09yE1IZtN1J3zeVnOaaLnCRSg2lWvwGos6pcLnvzUEGC9FevGfWKEjIQZO6z57BsW/k+1edwNUJpH7FNzmzF5/zid3+wDdzEd2mP4Y0OVdAd6l0oemndXsOQ0wQ2jYre2DXiQ+JRFOE696vpEUqQMm8dDStctLIKPG5WAeKguue2eorTF5fSc43qu/tzecaKGL2UMQVfIAu5wfT6S4uAxOpo0jLuwxqqlEbat6wIlpWCyESpFEoja7qpVnqG2cyAToSnvus2m82cT6WBFyhc6wmetYJDiTAZkOrMYm8yhdqwlb7jd/7p9WVjZOaY8BPB4eZ/tFWrKAZXenX0u5nFumwa2Pvv6TZQqORqLvoybkJnWAZtziK/Xlj+7GxKGep7l6X7/T/1wEIvlORBLLZ3qMFx6cEvhVAx8Zo+5MMHlUmgSLaRAL6kn9F8X6n2nvKGX3T36KXMEBeCVKWEhCUXFbJxz3otBUjaCzpYFuH5aM0DbotqrkNNoOd9oilH0d5oH5llH6lY6Qp1ZjzIHdMV/DCWmMeDqXgNcPakyX5d/zf4D+0LadhikLWctYQkJhoVCqkBCsc+glzk79tEER213nfjPr2i6+qQpfGYeoz8zcdaINRaiimuqTbBQ==",
      "region_name": "ap-southeast-1",
      "temp_access_secret": "dp****cx2mE2lZxsSq7kV++vWSL6RNatAhbqc"
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/admin/app/config/aws

    ARGUMENTS

    Parameter Description
    temp_expire_at timestamp The Unix timestamp at which this temporary bucket will expire.
    temp_access_id string Access ID - AWS SDK's config
    bucket_name string Bucket destination - AWS SDK's config
    temp_session_token string Tooken - AWS SDK's config
    region_name string Region name - AWS SDK's config
    temp_access_secret string Secret key - AWS SDK's config

    Was this section helpful? Yes No

    Categorization

    Categorization allows you to put videos into different groups by of folder, playlist, and tag. Normally this can be use to group videos into categories such as Action, Comedy, Gaming.

    ENDPOINTS

    POST /media/metadata
    GET /media/metadata?id=:metadata_id
    PUT /media/metadata?id=:metadata_id
    DELETE /media/metadata?id=:metadata_id
    GET /media/metadata
    

    Was this section helpful? Yes No

    The category object

    {
      "id": "f932aa79-852a-41f7-9adc-19935034f944",
      "name": "Playlist sample",
      "description": "Playlist description",
      "slug": "playlist-sample",
      "type": "playlist",
      "orderNumber": 3,
      "icon": "https:///example.com/image002.png",
      "status": 1,
      "createdAt": "2018-06-18T04:29:05.000Z",
      "updatedAt": "2018-06-18T04:29:05.000Z"
    }
    

    Attributes

    Parameter Description
    id string Unique identifier for the object.
    name string The category’s name, meant to be displayable to end users.
    type string Allowed values: [ folder|playlist|tag ].
    description string The category’s description, meant to be displayable to end users.
    orderNumber string The category's display order, categories with smaller number will be displayed first.
    icon string The URL to the category's icon.
    status number Status of category
    createdAt datetime The time at which the category was created. The format is ISO 8601.
    updatedAt datetime The time at which the category was last edited. The format is ISO 8601.

    Was this section helpful? Yes No

    Create category

    REQUEST

    curl -X POST \
      'https://api.uiza.io/api/public/v4/media/metadata' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "name": "Folder sample",
        "type": "folder",
        "description": "Folder description",
        "orderNumber": 1,
        "icon":"https://exemple.com/icon.png"
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      name: "Folder sample",
      type: "folder",
      description: "Folder description",
      orderNumber: 1
    }
    
    begin
      category = Uiza::Category.create params
      puts category.id
      puts category.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.category import Category
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    category_data = {
      "name": "Folder sample",
      "type": "folder",
      "description": "Folder description",
      "orderNumber": 1
    }
    
    try:
      res, status_code = Entity().create(**category_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "name" => "Folder sample",
      "type" => "folder",
      "description" => "Folder description",
      "orderNumber" => 1
    ];
    
    try {
      $category = Uiza\Category::create($params);
    
      print_r($category);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Category;
    import io.uiza.model.Category.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("name", "Folder sample");
        params.put("type", Type.FOLDER.toString());
        params.put("description", "Folder description");
        params.put("orderNumber", 1);
    
        try {
          JsonObject response = Category.create(params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'name': 'Folder sample',
      'type': 'folder',
      'description': 'Folder description',
      'orderNumber': 1
    };
    
    uiza.category.create(params)
      .then((res) => {
        //Identifier of category has been created
      }).catch((err) => {
        //Error
      });
    
    import (
      "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/category"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.CategoryCreateParams{
      Name: uiza.String("Folder sample"),
      Type: uiza.String("folder"),
      Description: uiza.String("Folder description"),
      OrderNumber: 1,
    }
    
    response, err := category.Create(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Category.Create(new CreateCategoryParameter()
      {
        Name = string.Format("Folder sample"),
        Type = string.Format("folder"),
        Description = string.Format("Folder description"),
        OrderNumber = 1
      });
    
      Console.WriteLine(string.Format("Create New Category Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Categories can be created and added to videos entity by using category relation. The difference between folder, playlist, tag are their purposes.

    RESPONSE

    {
      "id": "e56934c6-979e-4d4e-8d9a-ec0b4248365c"
    }
    

    HTTP Request

    POST https://api.uiza.io/api/public/v4/media/metadata

    ARGUMENTS

    Parameter Description Required
    name string Name of category, meant to be displayable to end users. Yes
    type enum Allowed values: [ folder|playlist|tag ]. Yes
    description string The category's description, meant to be displayable to end users.
    orderNumber integer The category's display order, categories with smaller number will be displayed first.
    icon string The URL to the category's icon.

    RETURNS

    Returns a category identifier if the call succeeded.

    Was this section helpful? Yes No

    Retrieve category

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/media/metadata?id=10e9537d-2a4e-4394-8825-32f3a25199e7' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      category = Uiza::Category.retrieve "10e9537d-2a4e-4394-8825-32f3a25199e7"
      puts category.id
      puts category.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.category import Category
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Category().retrieve(id="10e9537d-2a4e-4394-8825-32f3a25199e7")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $category = Uiza\Category::retrieve("10e9537d-2a4e-4394-8825-32f3a25199e7");
    
      print_r($category);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Category;
    import io.uiza.model.Category.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Category.retrieve("10e9537d-2a4e-4394-8825-32f3a25199e7");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '10e9537d-2a4e-4394-8825-32f3a25199e7'
    };
    
    uiza.category.retrieve(params)
      .then((res) => {
        //Identifier of category
      }).catch((err) => {
        //Error
      });
    
    import (
      "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/category"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.CategoryIDParams{ID :uiza.String("10e9537d-2a4e-4394-8825-32f3a25199e7")}
    response, err := category.Retrieve(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Category.Retrieve(new RetriveCategoryParameter()
      {
        Id = "10e9537d-2a4e-4394-8825-32f3a25199e7"
      });
      Console.WriteLine(string.Format("Get Category Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Retrieve the details of an existing category. Supply the unique category ID from either an category creation request or the category list, and Uiza will return the corresponding category information.

    RESPONSE

    {
      "id": "10e9537d-2a4e-4394-8825-32f3a25199e7",
      "name": "Folder sample",
      "description": "Folder description",
      "slug": "playlist-sample",
      "type": "playlist",
      "orderNumber": 1,
      "icon": "https:///example.com/image002.png",
      "status": 1,
      "createdAt": "2018-06-18T04:29:05.000Z",
      "updatedAt": "2018-06-18T04:29:05.000Z"
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/media/metadata

    ARGUMENTS

    Parameter Description Required
    id string The identifier of the category to be retrieved. Yes

    RETURNS

    Returns a category object if a valid identifier was provided.

    Was this section helpful? Yes No

    List categories

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/media/metadata' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      categories = Uiza::Category.list
      puts categories.first.id
      puts categories.first.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.category import Category
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Category().list()
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $categories =  Uiza\Category::list();
    
      print_r($categories);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Category;
    import io.uiza.model.Category.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonArray response = Category.list();
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    uiza.category.list()
      .then((res) => {
        //Identifier of category list
      }).catch((err) => {
        //Error
      });
    
    import (
      "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/category"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.CategoryListParams{}
    listData, err := category.List(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Category.List();
    
      Console.WriteLine(string.Format("Success Get List Category, total record {0}", result.MetaData.result));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Returns a list of your categories. The categories are returned sorted by orderNumber, with the smallest orderNumber appearing first.

    RESPONSE

    {
      "data": [
          {
              "id": "f932aa79-852a-41f7-9adc-19935034f944",
              "name": "Playlist sample",
              "description": "Playlist desciption",
              "slug": "playlist-sample",
              "type": "playlist",
              "orderNumber": 3,
              "icon": "/example.com/image002.png",
              "status": 1,
              "createdAt": "2018-06-18T04:29:05.000Z",
              "updatedAt": "2018-06-18T04:29:05.000Z"
          },
          {
              "id": "ab54db88-0c8c-4928-b1be-1e7120ad2c39",
              "name": "Folder sample",
              "description": "Folder's description",
              "slug": "folder-sample",
              "type": "folder",
              "orderNumber": 1,
              "icon": "/example.com/icon.png",
              "status": 1,
              "createdAt": "2018-06-18T03:17:07.000Z",
              "updatedAt": "2018-06-18T03:17:07.000Z"
          }
      ],
      "metadata": {
          "total": 2,
          "result": 2,
          "page": 1,
          "limit": 20
      }
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/media/metadata

    RETURNS

    A dictionary with a data property that contains an array of up to limit categories. Each entry in the array is a separate category object. If no more categories are available, the resulting array will be empty. This request should never return an error.

    Was this section helpful? Yes No

    Update a category

    REQUEST

    curl -X PUT \
      'https://api.uiza.io/api/public/v4/media/metadata' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "e56934c6-979e-4d4e-8d9a-ec0b4248365c",
        "name": "Folder edited",
        "type": "folder",
        "description": "Folder description new",
        "orderNumber": 1
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      id: "e56934c6-979e-4d4e-8d9a-ec0b4248365c",
      name: "Folder edited",
      type: "folder",
      description: "Folder description new",
      orderNumber: 1
    }
    
    begin
      category = Uiza::Category.update params
      puts category.id
      puts category.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.category import Category
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    category_data = {
      "id": "e56934c6-979e-4d4e-8d9a-ec0b4248365c",
      "name": "Folder edited",
      "type": "folder",
      "description": "Folder description new",
      "orderNumber": 1
    }
    
    try:
      res, status_code = Category().update(**category_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "name" => "Folder edited",
      "type" => "folder",
      "description" => "Folder description new",
      "orderNumber" => 1
    ];
    
    try {
      $category = Uiza\Category::update("e56934c6-979e-4d4e-8d9a-ec0b4248365c", $params);
    
      print_r($category);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Category;
    import io.uiza.model.Category.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("name", "Folder edited");
        params.put("type", Type.FOLDER.toString());
        params.put("description", "Folder description new");
        params.put("orderNumber", 1);
    
        try {
          JsonObject response = Category.update("e56934c6-979e-4d4e-8d9a-ec0b4248365c", params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': 'e56934c6-979e-4d4e-8d9a-ec0b4248365c',
      'name': 'Folder edited',
      'type': 'folder',
      'description': 'Folder description new',
      'orderNumber': 1
    }
    
    uiza.category.update(params)
      .then((res) => {
        //Identifier of category has been updated
      }).catch((err) => {
        //Error
      });
    
    import (
      "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/category"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.CategoryUpdateParams{
      ID: uiza.String("e56934c6-979e-4d4e-8d9a-ec0b4248365c"),
      Name: uiza.String("Folder edited"),
      Type: uiza.String("folder"),
      Description: uiza.String("Folder description new"),
      OrderNumber: 1,
    }
    
    response, err := category.Update(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Category.Update(new UpdateCategoryParameter()
      {
        ID = "e56934c6-979e-4d4e-8d9a-ec0b4248365c",
        Name = string.Format("Folder edited"),
        Type = string.Format("folder"),
        Description = string.Format("Folder description new"),
        OrderNumber = 1
      });
    
      Console.WriteLine(string.Format("Update Category Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Updates the specified category by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    RESPONSE

    {
      "id": "e56934c6-979e-4d4e-8d9a-ec0b4248365c"
    }
    

    HTTP Request

    PUT https://api.uiza.io/api/public/v4/media/metadata

    ARGUMENTS

    Parameter Description Required
    id string Identifier of category Yes
    name string The category’s name, meant to be displayable to end users. Yes
    type enum Allowed values [ folder|playlist|tag ]. Yes
    description string The category’s description, meant to be displayable to end users.
    orderNumber integer The category's display order, categories with smaller number will be displayed first.
    icon string The URL to the category's icon.

    RETURNS

    Returns the ID of the updated category if the update succeeded.

    Was this section helpful? Yes No

    Delete a category

    REQUEST

    curl -X DELETE \
      'https://api.uiza.io/api/public/v4/media/metadataid=a257d0b7-4a58-44ac-b2ff-0cb26006daa4' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::Category.delete "a257d0b7-4a58-44ac-b2ff-0cb26006daa4"
      puts response.id
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.category import Category
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Category().delete(id="a257d0b7-4a58-44ac-b2ff-0cb26006daa4")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $response = Uiza\Category::delete("a257d0b7-4a58-44ac-b2ff-0cb26006daa4");
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Category;
    import io.uiza.model.Category.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Category.delete("a257d0b7-4a58-44ac-b2ff-0cb26006daa4");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      id: 'a257d0b7-4a58-44ac-b2ff-0cb26006daa4'
    };
    
    uiza.category.delete(params)
      .then((res) => {
        //Identifier of category has been deleted
      }).catch((err) => {
        //Error
      });
    
    import (
      "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/category"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.CategoryIDParams{ID: uiza.String("a257d0b7-4a58-44ac-b2ff-0cb26006daa4")}
    response, err := category.Delete(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Category.Delete("a257d0b7-4a58-44ac-b2ff-0cb26006daa4");
      Console.WriteLine(string.Format("Delete Category Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Permanently deletes a category. It cannot be undone.

    RESPONSE

    {
      "id": "a257d0b7-4a58-44ac-b2ff-0cb26006daa4"
    }
    

    HTTP Request

    DELETE https://api.uiza.io/api/public/v4/media/metadata

    ARGUMENTS

    Parameter Description Required
    id string The ID of the category to be deleted. Yes

    RETURNS

    Returns an ID of the deleted category on success. Otherwise, this call returns an error.

    Was this section helpful? Yes No

    Create category relation

    REQUEST

    curl -X POST \
      'https://api.uiza.io/api/public/v4/media/entity/related/metadata' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "entityId": "680bef00-bb0c-4bed-9624-19109504fcfe",
        "metadataIds": ["35a3e064-8aea-4a0a-a03c-d6927ad98ae1", "9b0c0c57-f85c-43d1-880b-23359c8374f4"]
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      entityId: "680bef00-bb0c-4bed-9624-19109504fcfe",
      metadataIds: ["35a3e064-8aea-4a0a-a03c-d6927ad98ae1", "9b0c0c57-f85c-43d1-880b-23359c8374f4"]
    }
    
    begin
      relations = Uiza::Category.create_relation params
      puts relations.first.id
      puts relations.first.entityId
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.category import Category
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    relations_data = {
      "entity_id": "680bef00-bb0c-4bed-9624-19109504fcfe",
      "metadata_ids": ["35a3e064-8aea-4a0a-a03c-d6927ad98ae1", "9b0c0c57-f85c-43d1-880b-23359c8374f4"]
    }
    
    try:
      res, status_code = Category().create_relation(**relations_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "entityId" => "680bef00-bb0c-4bed-9624-19109504fcfe",
      "metadataIds" => ["35a3e064-8aea-4a0a-a03c-d6927ad98ae1", "9b0c0c57-f85c-43d1-880b-23359c8374f4"]
    ];
    
    try {
      $relations = Uiza\Category::createRelation($params);
    
      print_r($relations);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Category;
    import io.uiza.model.Category.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("entityId", "680bef00-bb0c-4bed-9624-19109504fcfe");
        params.put("metadataIds", new String[] {"35a3e064-8aea-4a0a-a03c-d6927ad98ae1", "9b0c0c57-f85c-43d1-880b-23359c8374f4"});
    
        try {
          JsonArray response = Category.createRelation(params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'entityId': '680bef00-bb0c-4bed-9624-19109504fcfe',
      'metadataIds': ['35a3e064-8aea-4a0a-a03c-d6927ad98ae1','9b0c0c57-f85c-43d1-880b-23359c8374f4']
    };
    
    uiza.category.create_relation(params)
      .then((res) => {
        //Identifier of relation between entity and category has been created
      }).catch((err) => {
        //Error
      });
    
    import (
      "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/category"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.CategoryRelationParams{
      EntityId: uiza.String("680bef00-bb0c-4bed-9624-19109504fcfe"),
      MetadataIds: []*string{
      uiza.String("35a3e064-8aea-4a0a-a03c-d6927ad98ae1"),
      uiza.String("9b0c0c57-f85c-43d1-880b-23359c8374f4"),
    }}
    response, err := category.CreateRelation(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var listMetadata = new List<string>()
      {
        "35a3e064-8aea-4a0a-a03c-d6927ad98ae1",
        "9b0c0c57-f85c-43d1-880b-23359c8374f4"
      };
    
      var result = UizaServices.Category.CreateRelation(new CategoryRelationParameter()
      {
        EntityId = "680bef00-bb0c-4bed-9624-19109504fcfe",
        MetadataIds = listMetadata
      });
      Console.WriteLine(string.Format("Create Category Relation Success, total record {0}", result.MetaData.result));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Category relation allows you to put entities into categories. In case you create entities before categories, you should use this to categorize those entities. You can also use this API to add entities to more categories.

    RESPONSE

    {
        "data": [
            {
                "id": "5620ed3c-b725-4a9a-8ec1-ecc9df3e5aa6",
                "entityId": "680bef00-bb0c-4bed-9624-19109504fcfe",
                "metadataId": "35a3e064-8aea-4a0a-a03c-d6927ad98ae1"
            },
            {
                "id": "47209e60-a99f-4c96-99fb-be4f858481b4",
                "entityId": "680bef00-bb0c-4bed-9624-19109504fcfe",
                "metadataId": "9b0c0c57-f85c-43d1-880b-23359c8374f4"
            }
        ],
        "metadata": {
            "total": 2,
            "result": 2,
            "page": 1,
            "limit": 20
        }
    }
    

    HTTP Request

    POST https://api.uiza.io/api/public/v4/media/entity/related/metadata

    ARGUMENTS

    Parameter Type Description Required
    entityId string Identifier of entity Yes
    metadataIds string Identifier of category Yes

    RETURNS

    Parameter Type Description
    id string Identifier of relation between entity and category has been created
    entityId string Identifier of entity
    metadataIds string Identifier of category

    Was this section helpful? Yes No

    Delete category relation

    REQUEST

    curl -X DELETE \
      'https://api.uiza.io/api/public/v4/media/entity/related/metadata' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "entityId": "680bef00-bb0c-4bed-9624-19109504fcfe",
        "metadataIds": ["35a3e064-8aea-4a0a-a03c-d6927ad98ae1", "9b0c0c57-f85c-43d1-880b-23359c8374f4"]
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      entityId: "680bef00-bb0c-4bed-9624-19109504fcfe",
      metadataIds: ["35a3e064-8aea-4a0a-a03c-d6927ad98ae1", "9b0c0c57-f85c-43d1-880b-23359c8374f4"]
    }
    
    begin
      relations = Uiza::Category.delete_relation params
      puts relations.first.id
      puts relations.first.entityId
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.category import Category
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    relations_data = {
      "entity_id": "680bef00-bb0c-4bed-9624-19109504fcfe",
      "metadata_ids": ["35a3e064-8aea-4a0a-a03c-d6927ad98ae1", "9b0c0c57-f85c-43d1-880b-23359c8374f4"]
    }
    
    try:
      res, status_code = Category().delete_relation(**relations_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "entityId" => "680bef00-bb0c-4bed-9624-19109504fcfe",
      "metadataIds" => ["35a3e064-8aea-4a0a-a03c-d6927ad98ae1", "9b0c0c57-f85c-43d1-880b-23359c8374f4"]
    ];
    
    try {
      $response = Uiza\Category::deleteRelation($params);
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Category;
    import io.uiza.model.Category.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("entityId", "680bef00-bb0c-4bed-9624-19109504fcfe");
        params.put("metadataIds", new String[] {"35a3e064-8aea-4a0a-a03c-d6927ad98ae1", "9b0c0c57-f85c-43d1-880b-23359c8374f4"});
    
        try {
          JsonArray response = Category.deleteRelation(params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'entityId': '680bef00-bb0c-4bed-9624-19109504fcfe',
      'metadataIds': ['35a3e064-8aea-4a0a-a03c-d6927ad98ae1','9b0c0c57-f85c-43d1-880b-23359c8374f4']
    };
    
    uiza.category.delete_relation(params)
      .then((res) => {
        //Identifier of relation between entity and category has been deleted
      }).catch((err) => {
        //Error
      });
    
    import (
      "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/category"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.CategoryRelationParams{
      EntityId: uiza.String("680bef00-bb0c-4bed-9624-19109504fcfe"),
      MetadataIds: []*string{
        uiza.String("35a3e064-8aea-4a0a-a03c-d6927ad98ae1"),
        uiza.String("9b0c0c57-f85c-43d1-880b-23359c8374f4"),
    }}
    
    response, err := category.DeleteRelation(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var listMetadata = new List<string>()
      {
        "35a3e064-8aea-4a0a-a03c-d6927ad98ae1",
        "9b0c0c57-f85c-43d1-880b-23359c8374f4"
      };
    
      var result = UizaServices.Category.DeleteRelation(new CategoryRelationParameter()
      {
        EntityId = "680bef00-bb0c-4bed-9624-19109504fcfe",
        MetadataIds = listMetadata
      });
      Console.WriteLine(string.Format("Delete Category Relation Success, total record {0}", result.MetaData.result));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Delete relation for entity and category

    RESPONSE

    {
        "data": [
            {
                "id": "5620ed3c-b725-4a9a-8ec1-ecc9df3e5aa6",
                "entityId": "680bef00-bb0c-4bed-9624-19109504fcfe",
                "metadataId": "35a3e064-8aea-4a0a-a03c-d6927ad98ae1"
            },
        ],
        "metadata": {
            "total": 1,
            "result": 1,
            "page": 1,
            "limit": 20
        }
    }
    

    HTTP Request

    DELETE https://api.uiza.io/api/public/v4/media/entity/related/metadata

    ARGUMENTS

    Parameter Type Description Required
    entityId string Identifier of entity
    metadataIds string Identifier of category

    RETURNS

    Parameter Type Description
    id string Identifier of relation between entity and category has been deleted
    entityId string Identifier of entity
    metadataIds string Identifier of category

    Was this section helpful? Yes No

    Storage

    Uiza allows you to add storages (FTP, S3 - both private and AWS) to your application. Storages can be used for creating entities.

    Was this section helpful? Yes No

    The storage object

    THE STORAGE OBJECT

    {
      "id": "cd003123-7ec9-4f3a-9d7c-f2de93e83e49",
      "name": "FTP Uiza",
      "description": "FTP of Uiza, use for transcode",
      "storageType": "ftp",
      "usageType": "input",
      "bucket": null,
      "prefix": null,
      "host": "ftp-exemple.uiza.io",
      "awsAccessKey": null,
      "awsSecretKey": null,
      "username": "uiza",
      "password": "=5;9x@LPsd+w7qW",
      "region": null,
      "port": 21,
      "createdAt": "2018-06-19T03:01:56.000Z",
      "updatedAt": "2018-06-19T03:01:56.000Z"
    }
    

    Attributes

    Parameter Description
    id string Identifier of storage
    name string Name of storage
    description string Storage's description
    storageType string Storage can be FTP or AWS S3
    usageType string Input storage
    bucket string Bucket data of AWS S3
    prefix string Prefix for objects store in AWS S3
    host string Storage host (AWS S3, FTP)
    awsAccessKey string AccessKeyId
    awsSecretKey string SecretKeyId
    username string UserName of FTP
    password string Password of FTP
    region string AWS S3 region
    port number Storage port
    createdAt datetime Time created storage
    updatedAt datetime Last edited time of storage

    Was this section helpful? Yes No

    Add a storage

    Uiza allows you to add storages (FTP, S3 - both private and AWS) to your application. Storages can be used for creating entities.

    Add a FTP Storage

    REQUEST

    curl -X POST \
      'https://api.uiza.io/api/public/v4/media/storage' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "name": "FTP Uiza",
        "description": "FTP of Uiza, use for transcode",
        "storageType": "ftp",
        "host": "ftp-example.uiza.io",
        "username": "uiza",
        "password": "=59x@LPsd+w7qW",
        "port": 21
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      name: "FTP Uiza",
      description: "FTP of Uiza, use for transcode",
      storageType: "ftp",
      host: "ftp-example.uiza.io",
      username: "uiza",
      password: "=59x@LPsd+w7qW",
      port: 21
    }
    
    begin
      storage = Uiza::Storage.add params
      puts storage.id
      puts storage.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.storage import Storage
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    storage_data = {
      "name": "FTP Uiza",
      "description": "FTP of Uiza, use for transcode",
      "storageType": "ftp",
      "host": "ftp-example.uiza.io",
      "username": "uiza",
      "password": "=59x@LPsd+w7qW",
      "port": 21
    }
    
    try:
      res, status_code = Storage().add(**storage_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "name" => "FTP Uiza",
      "description" => "FTP of Uiza, use for transcode",
      "storageType" => "ftp",
      "host" => "ftp-example.uiza.io",
      "username" => "uiza",
      "password" => "=59x@LPsd+w7qW",
      "port" => 21
    ];
    
    try {
      $storage = Uiza\Storage::add($params);
    
      print_r($storage);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Storage;
    import io.uiza.model.Storage.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("name", "FTP Uiza");
        params.put("description", "FTP of Uiza, use for transcode");
        params.put("storageType", StorageType.FTP.toString());
        params.put("host", "ftp-example.uiza.io");
        params.put("username", "uiza");
        params.put("password", "=59x@LPsd+w7qW");
        params.put("port", 21);
    
        try {
          JsonObject response = Storage.add(params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'name': 'FTP Uiza',
      'description': 'FTP of Uiza, use for transcode',
      'storageType': 'ftp',
      'host': 'ftp-example.uiza.io',
      'username': 'uiza',
      'password': '=59x@LPsd+w7qW',
      'port': 21
    }
    
    uiza.storage.add(params)
      .then((res) => {
        //Identifier of storage has been add
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/storage"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params :=  &uiza.StorageAddParams{
      Name: uiza.String("FTP Uiza"),
      Host: uiza.String("ftp-example.uiza.io"),
      Port: 21,
      StorageType: "ftp",
      Username: uiza.String("uiza"),
      Password: uiza.String("=59x@LPsd+w7qW"),
      Description: uiza.String("FTP of Uiza, use for transcode"),
    }
    
    response, err := storage.Add(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Storage.Add(new AddStorageParameter()
      {
        Name = "FTP Uiza",
        Description = "FTP of Uiza, use for transcode",
        StorageType = "ftp",
        Host = "ftp-example.uiza.io",
        Username = "uiza",
        Password = "=59x@LPsd+w7qW",
        Port = 21
      });
    
      Console.WriteLine(string.Format("Add New Storage Id = {0} Success", createResult.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Add a S3 Storage

    curl -X POST \
      'https://api.uiza.io/api/public/v4/media/storage' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "name": "S3 Uiza",
        "description": "S3 of Uiza, use for transcode",
        "storageType": "s3",
        "host": "s3-example.uiza.io",
        "username": "uiza",
        "password": "=59x@LPsd+w7qW",
        "port": 21
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      name: "S3 Uiza",
      description: "S3 of Uiza, use for transcode",
      storageType: "s3",
      host: "s3-example.uiza.io",
      username: "uiza",
      password: "=59x@LPsd+w7qW",
      port: 21
    }
    
    begin
      storage = Uiza::Storage.add params
      puts storage.id
      puts storage.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.storage import Storage
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    storage_data = {
      "name": "S3 Uiza",
      "description": "S3 of Uiza, use for transcode",
      "storageType": "s3",
      "host": "s3-example.uiza.io",
      "username": "uiza",
      "password": "=59x@LPsd+w7qW",
      "port": 21
    }
    
    try:
      res, status_code = Storage().add(**storage_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "name" => "S3 Uiza",
      "description" => "S3 of Uiza, use for transcode",
      "storageType" => "s3",
      "host" => "s3-example.uiza.io",
      "username" => "uiza",
      "password" => "=59x@LPsd+w7qW",
      "port" => 21
    ];
    
    try {
      $storage = Uiza\Storage::add($params);
    
      print_r($storage);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Storage;
    import io.uiza.model.Storage.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("name", "S3 Uiza");
        params.put("description", "S3 of Uiza, use for transcode");
        params.put("storageType", StorageType.S3.toString());
        params.put("host", "s3-example.uiza.io");
        params.put("username", "uiza");
        params.put("password", "=59x@LPsd+w7qW");
        params.put("port", 21);
    
        try {
          JsonObject response = Storage.add(params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'name': 'S3 Uiza',
      'description': 'S3 of Uiza, use for transcode',
      'storageType': 's3',
      'host': 's3-example.uiza.io',
      'username': 'uiza',
      'password': '=59x@LPsd+w7qW',
      'port': 21
    }
    
    uiza.storage.add(params)
      .then((res) => {
        //Identifier of storage has been add
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/storage"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params :=  &uiza.StorageAddParams{
      Name: uiza.String("S3 Uiza"),
      Host: uiza.String("s3-example.uiza.io"),
      Port: 21,
      StorageType: "s3",
      Username: uiza.String("uiza"),
      Password: uiza.String("=59x@LPsd+w7qW"),
      Description: uiza.String("S3 of Uiza, use for transcode"),
    }
    
    response, err := storage.Add(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Storage.Add(new AddStorageParameter()
      {
        Name = "S3 Uiza",
        Description = "S3 of Uiza, use for transcode",
        StorageType = "s3",
        Host = "s3-example.uiza.io",
        Username = "uiza",
        Password = "=59x@LPsd+w7qW",
        Port = 21
      });
    
      Console.WriteLine(string.Format("Add New Storage Id = {0} Success", createResult.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    RESPONSE

    {
      "id": "ca028a29-612c-40a8-add2-6dc811a2320f"
    }
    

    HTTP Request

    POST https://api.uiza.io/api/public/v4/media/storage

    ARGUMENTS

    FTP storage

    Parameter Description Required
    name string Storage's name. Used for references. Yes
    host string Host name or IP Address of the FTP server. Yes
    port int FTP Port. Yes
    type string Must be set to ftp for this storage type. Yes
    username string FTP username
    password string FTP password
    description string Storage's description

    S3 storage

    Parameter Description Required
    name string Name of the storage Yes
    host string Host name or IP Address of the S3 server. Yes
    port int S3's port. Usually it's 443. Yes
    type string Must be set to s3 for this storage type. Yes
    awsAccessKey string AWS Access key ID.
    awsSecretKey string AWS Secret key ID.
    prefix string Prefix for objects store in this S3.
    bucket string Bucket data of S3.
    region string Storage's region, applicable for AWS S3.
    description string Storage's description

    RETURNS

    Returns a storage identifier if the call succeeded.

    Was this section helpful? Yes No

    Retrieve a storage

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/media/storage?id=ca028a29-612c-40a8-add2-6dc811a2320f' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "json"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      storage = Uiza::Storage.retrieve "ca028a29-612c-40a8-add2-6dc811a2320f"
      puts storage.id
      puts storage.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.storage import Storage
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Storage().retrieve(id="ca028a29-612c-40a8-add2-6dc811a2320f")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $storage = Uiza\Storage::retrieve("ca028a29-612c-40a8-add2-6dc811a2320f");
    
      print_r($storage);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Storage;
    import io.uiza.model.Storage.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Storage.retrieve("ca028a29-612c-40a8-add2-6dc811a2320f");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': 'ca028a29-612c-40a8-add2-6dc811a2320f'
    };
    
    uiza.storage.retrieve(params)
      .then((res) => {
        //Identifier of storage has been retrive
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/storage"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.StorageRetrieveParams{ID: uiza.String("ca028a29-612c-40a8-add2-6dc811a2320f")}
    response, err := storage.Retrieve(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Storage.Retrieve("ca028a29-612c-40a8-add2-6dc811a2320f");
    
      Console.WriteLine(string.Format("Get Storage Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Retrieves the details of an existing storage. You need only supply the unique storage identifier that was returned upon storage creation.

    RESPONSE

    {
      "id": "ca028a29-612c-40a8-add2-6dc811a2320f",
      "name": "FTP Uiza",
      "description": "FTP of Uiza, use for transcode",
      "storageType": "",
      "usageType": "input",
      "bucket": null,
      "prefix": null,
      "host": "ftp-example.uiza.io",
      "awsAccessKey": null,
      "awsSecretKey": null,
      "username": "uiza",
      "password": "=59x@LPsd+w7qW",
      "region": null,
      "port": 21,
      "createdAt": "2018-06-19T03:01:56.000Z",
      "updatedAt": "2018-06-19T03:01:56.000Z"
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/media/storage

    ARGUMENTS

    Parameter Description Required
    id string The identifier of the storage to be retrieved. Yes

    RETURNS

    Returns a storage object if a valid identifier was provided.

    Was this section helpful? Yes No

    Update storage

    Update storage's information

    Update a FTP a Storage

    REQUEST

    curl -X PUT \
      'https://api.uiza.io/api/public/v4/media/storage' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "ca028a29-612c-40a8-add2-6dc811a2320f",
        "name": "FTP Uiza update",
        "description": "FTP of Uiza, use for transcode update",
        "storageType": "ftp",
        "host": "ftp-example.uiza.io",
        "username": "uiza",
        "password": "=59x@LPsd+w7qW",
        "port": 21
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      id: "ca028a29-612c-40a8-add2-6dc811a2320f",
      name: "FTP Uiza update",
      description: "FTP of Uiza, use for transcode update",
      storageType: "ftp"
    }
    
    begin
      storage = Uiza::Storage.update params
      puts storage.id
      puts storage.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.storage import Storage
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    storage_data = {
      "id": "ca028a29-612c-40a8-add2-6dc811a2320f",
      "name": "FTP Uiza update",
      "description": "FTP of Uiza, use for transcode update",
      "storageType": "ftp"
    }
    
    try:
      res, status_code = Storage().update(**storage_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "name" => "FTP Uiza update",
      "description" => "FTP of Uiza, use for transcode update",
      "storageType" => "ftp"
    ];
    
    try {
      $storage = Uiza\Storage::update("ca028a29-612c-40a8-add2-6dc811a2320f", $params);
    
      print_r($storage);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Storage;
    import io.uiza.model.Storage.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("name", "FTP Uiza update");
        params.put("description", "FTP of Uiza, use for transcode update");
        params.put("storageType", StorageType.FTP.toString());
    
        try {
          JsonObject response = Storage.update("ca028a29-612c-40a8-add2-6dc811a2320f", params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': 'ca028a29-612c-40a8-add2-6dc811a2320f',
      'name': 'FTP Uiza update',
      'description': 'FTP of Uiza, use for transcode update',
      'storageType': 'ftp'
    };
    
    uiza.storage.update(params)
      .then((res) => {
        //Identifier of storage has been update
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/storage"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params :=  &uiza.StorageUpdateParams{
      ID: uiza.String("ca028a29-612c-40a8-add2-6dc811a2320f"),
      Name: uiza.String("FTP Uiza update"),
      StorageType: "ftp",
      Description: uiza.String("FTP of Uiza, use for transcode update"),
    }
    
    response, err := storage.Update(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = uizaServices.Storage.Update(new UpdateStorageParameter()
      {
        ID = "ca028a29-612c-40a8-add2-6dc811a2320f",
        Name = "FTP Uiza",
        Description = "FTP of Uiza, use for transcode",
        StorageType = "ftp",
      });
      Console.WriteLine(string.Format("Update Storage Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
        var result = ex.UizaInnerException.Error;
    }
    

    RESPONSE

    {
      "id": "ca028a29-612c-40a8-add2-6dc811a2320f"
    }
    

    HTTP Request

    PUT https://api.uiza.io/api/public/v4/media/storage

    ARGUMENTS

    The storage's object

    RETURNS

    Returns the ID of the updated storage if the update succeeded.

    Was this section helpful? Yes No

    Delete a storage

    REQUEST

    curl -X DELETE \
      'https://api.uiza.io/api/public/v4/media/storage' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "444f0f71-e56b-449e-a9ec-435d3c974f16"
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::Storage.remove "444f0f71-e56b-449e-a9ec-435d3c974f16"
      puts response.id
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.storage import Storage
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Storage().remove(id="444f0f71-e56b-449e-a9ec-435d3c974f16")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $response = Uiza\Storage::remove("444f0f71-e56b-449e-a9ec-435d3c974f16");
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Storage;
    import io.uiza.model.Storage.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Storage.remove("444f0f71-e56b-449e-a9ec-435d3c974f16");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '444f0f71-e56b-449e-a9ec-435d3c974f16'
    };
    
    uiza.storage.remove(params)
      .then((res) => {
        //Identifier of storage has been removed
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/storage"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.StorageRemoveParams{ID: uiza.String("444f0f71-e56b-449e-a9ec-435d3c974f16")}
    response, err := storage.Remove(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Storage.Remove("444f0f71-e56b-449e-a9ec-435d3c974f16");
    
      Console.WriteLine(string.Format("Remove Storage Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Permanently deletes a storage. It cannot be undone.

    RESPONSE

    {
      "id": "cd003123-7ec9-4f3a-9d7c-f2de93e83e49",
    }
    

    HTTP Request

    DELETE https://api.uiza.io/api/public/v4/media/storage

    ARGUMENTS

    Parameter Description Required
    id string The ID of the storage to be deleted. Yes

    RETURNS

    Returns an ID of the deleted storage on success. Otherwise, this call returns an error.

    Was this section helpful? Yes No

    Live Streaming

    Live streaming is managed by Uiza's Live Event. A live event allows you to pull contents from other sources such as Youtube or any HLS links. You can also broadcast a live stream yourself with a push type of live event.

    A live event can be recorded. These records are save as entities.

    To start a live stream you must create a live event first.

    IMPORTANT: Live minutes start being counted as soon as the live event starts.

    Was this section helpful? Yes No

    The Live Event Object

    THE LIVE STREAM OBJECT

    {
      "id": "8b83886e-9cc3-4eab-9258-ebb16c0c73de",
      "name": "checking 01",
      "description": "checking",
      "mode": "pull",
      "resourceMode": "single",
      "encode": 0,
      "channelName": "checking-01",
      "lastPresetId": null,
      "lastFeedId": null,
      "poster": "https://example.com/poster.jpeg",
      "thumbnail": "https://example.com/thumbnail.jpeg",
      "linkPublishSocial": null,
      "linkStream": "[\"https://www.youtube.com/watch?v=pQzaHPoNX1I\"]",
      "lastPullInfo": null,
      "lastPushInfo": null,
      "lastProcess": null,
      "eventType": null,
      "createdAt": "2018-06-21T14:33:36.000Z",
      "updatedAt": "2018-06-21T14:33:36.000Z"
    }
    
    Attribute Description
    name string The event's name (limit to 100 characters)
    description string An arbitrary string attached to the object. Often useful for displaying to users.
    mode string Type of event, allowed values [pull|push].
    Pull links can either be a RTMP URL or a .m3u8 URL (HLS) or any Youtube link (live or not).
    Push: Uiza will generate an end point. This end point can be used on broadcasting softwares such as OBS to start your streaming.
    encode integer Set to 1 to enable live transcoding. Live transcoding will enable Adaptive Bitrate on the viewer's side which would help deliver a better viewing experience. When set to 0, viewers will watch with source bitrate.
    dvr integer Decides wether to record a live stream. If set to 1, a mp4 file will be created after the live stream ended. Set 0 to disable.
    linkPublishSocial array Live feed will be posted on this set of social links.
    poster string The video's poster URL, meant to be displayable to end users.
    thumbnail string An URL of the image that can be used to display to end users.
    channelName string Key name of channel
    createdAt datetime The time at which the live event was created. The format is ISO 8601.
    updatedAt datetime The time at which the live event was last edited. The format is ISO 8601.

    Was this section helpful? Yes No

    Create a live event

    REQUEST

    curl -X POST \
      'https://api.uiza.io/api/public/v4/live/entity' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "name": "test event",
        "mode": "push",
        "encode": 1,
        "dvr": 1,
        "description": "This is for test event",
        "poster": "//image1.jpeg",
        "thumbnail": "//image1.jpeg",
        "linkStream": [
          "https://playlist.m3u8"
        ],
        "resourceMode": "single"
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      name: "test event",
      mode: "push",
      encode: 1,
      dvr: 1,
      description: "This is for test event",
      poster: "//image1.jpeg",
      thumbnail: "//image1.jpeg",
      linkStream: [
        "https://playlist.m3u8"
      ],
      resourceMode: "single"
    }
    
    begin
      live = Uiza::Live.create params
      puts live.id
      puts live.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.live import Live
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    live_data = {
      "name": "test event",
      "mode": "push",
      "encode": 1,
      "dvr": 1,
      "description": "This is for test event",
      "poster": "//image1.jpeg",
      "thumbnail": "//image1.jpeg",
      "linkStream": [
        "https://playlist.m3u8"
      ],
      "resourceMode": "single"
    }
    
    try:
      res, status_code = Live().create(**live_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "name" => "test event",
      "mode" => "push",
      "encode" => 1,
      "dvr" => 1,
      "description" => "This is for test event",
      "poster" => "//image1.jpeg",
      "thumbnail" => "//image1.jpeg",
      "linkStream" => [
        "https://playlist.m3u8"
      ],
      "resourceMode" => "single"
    ];
    
    try {
      $live = Uiza\Live::create($params);
    
      print_r($live);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Live;
    import io.uiza.model.Live.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("name", "test event");
        params.put("mode", Mode.PUSH.toString());
        params.put("encode", Encode.ENCODE.getVal());
        params.put("dvr", Dvr.ACTIVE_RECORD.getVal());
        params.put("description", "This is for test event");
        params.put("poster", "//image1.jpeg");
        params.put("thumbnail", "//image1.jpeg");
        params.put("linkStream", new String[] {"https://playlist.m3u8"});
        params.put("resourceMode", ResourceMode.SINGLE.toString());
    
        try {
          JsonObject response = Live.create(params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'name': 'test event',
      'mode': 'push',
      'encode': 1,
      'dvr': 1,
      'description': 'This is for test event',
      'poster': '//image1.jpeg',
      'thumbnail': '//image1.jpeg',
      'linkStream': [
        'https://playlist.m3u8'
      ],
      'resourceMode': 'single'
    };
    
    uiza.live.create(params)
      .then((res) => {
          //Identifier of event has been created
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/live"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.LiveCreateParams{
      Name: uiza.String("test event"),
      Mode: uiza.String("push"),
      Encode: 1,
      Dvr: 1,
      Description: uiza.String("This is for test event"),
      Thumbnail: uiza.String("//image1.jpeg"),
      Poster: uiza.String("//image1.jpeg"),
      LinkStream: &[]string{*uiza.String("https://playlist.m3u8")},
      ResourceMode: uiza.String("single"),
    }
    response, err := live.Create(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Live.Create(new CreateLiveParameter()
      {
        Name: "test event",
        Mode: "push",
        Description: "This is for test event",
        Encode: 1,
        Dvr: 1,
        Poster: "//image1.jpeg",
        Thumbnail: new List<string>() {"//image1.jpeg"},
        LinkStream: [
          "https://playlist.m3u8"
        ],
        resourceMode: "single"
      });
    
      Console.WriteLine(string.Format("Create Live Streaming Success New Id = {0}", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Creates a new live event to manage a live stream.

    IMPORTANT: Live minutes start being counted as soon as the live event starts.

    RESPONSE

    {
      "id": "471734b1-90b8-44c5-b24b-132ed9d7529b"
    }
    

    HTTP Request

    POST https://api.uiza.io/api/public/v4/live/entity

    ARGUMENTS

    Parameter Description Required
    name string The event name (limit 100 characters) Yes
    mode string Type of event, allowed values [pull|push].
    Pull links can either be a RTMP URL or a .m3u8 URL or a live youtube link
    Push: Uiza will generate an end point. This end point can be used on Broadcasting softwares such as OBS to start your streaming.
    Yes
    encode integer Set to 1 to enable live transcoding. Live transcoding will enable Adaptive Bitrate on the viewer's side which would help deliver a better viewing experience. When set to 0, viewers will watch with source bitrate. Yes
    dvr integer Decides wether to record a live stream. If set to 1, a mp4 file will be created after the live stream ended. Set 0 to disable. Yes
    description string An arbitrary string attached to the object. Often useful for displaying to users.
    linkPublishSocial array Info to share live into social
    dropdown: type of social (youtube/facebook).

    address:: stream URL.

    streamKey:: stream key correspond to stream URL.
    thumbnail string An URL of the image that can be used to display to end users.
    linkStream array A list of streamable sources that will be used when mode = pull. Yes
    resourceMode enum Resource mode ( single = only 1 feed & output), redundant = more than 1 feed & output to backup) Yes

    RETURNS

    Returns a live event identifier if the call succeeded.

    Was this section helpful? Yes No

    Retrieve a live event

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/live/entity?id=471734b1-90b8-44c5-b24b-132ed9d7529b' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      live = Uiza::Live.retrieve "471734b1-90b8-44c5-b24b-132ed9d7529b"
      puts live.id
      puts live.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.live import Live
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Live().retrieve(id="471734b1-90b8-44c5-b24b-132ed9d7529b")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $live = Uiza\Live::retrieve("471734b1-90b8-44c5-b24b-132ed9d7529b");
    
      print_r($live);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Live;
    import io.uiza.model.Live.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Live.retrieve("471734b1-90b8-44c5-b24b-132ed9d7529b");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '471734b1-90b8-44c5-b24b-132ed9d7529b'
    };
    
    uiza.live.retrieve(params)
      .then((res) => {
        //Identifier of live event has been retrieved
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/live"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.LiveRetrieveParams{ID: uiza.String("471734b1-90b8-44c5-b24b-132ed9d7529b")}
    response, err := live.Retrieve(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Live.Retrieve(new GetLiveParameter()
      {
        Id = "471734b1-90b8-44c5-b24b-132ed9d7529b"
      });
      Console.WriteLine(string.Format("Get Category Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Retrieves the details of an existing event. You need only provide the unique identifier of event that was returned upon Live event creation.

    RESPONSE

    {
      "id": "471734b1-90b8-44c5-b24b-132ed9d7529b",
      "name": "test event",
      "description": "This is for test event",
      "mode": "push",
      "resourceMode": "single",
      "encode": 1,
      "channelName": "checking-01",
      "lastPresetId": null,
      "lastFeedId": null,
      "poster": "//image1.jpeg",
      "thumbnail": "//image1.jpeg",
      "linkPublishSocial": null,
      "linkStream": "[
        "https://playlist.m3u8"
      ]",
      "lastPullInfo": null,
      "lastPushInfo": null,
      "lastProcess": null,
      "eventType": null,
      "createdAt": "2018-06-21T14:33:36.000Z",
      "updatedAt": "2018-06-21T14:33:36.000Z"
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/live/entity

    ARGUMENTS

    Parameter Description
    id string The identifier of the live event to be retrieved.

    RETURNS

    Returns a live event object if a valid identifier was provided.

    Was this section helpful? Yes No

    Update a live event

    REQUEST

    curl -X PUT \
      'https://api.uiza.io/api/public/v4/live/entity' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "471734b1-90b8-44c5-b24b-132ed9d7529b",
        "name": "live test",
        "mode": "pull",
        "encode": 0,
        "dvr": 1,
        "resourceMode": "single"
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      id: "471734b1-90b8-44c5-b24b-132ed9d7529b",
      name: "live test",
      mode: "pull",
      encode: 0,
      dvr: 1,
      resourceMode: "single"
    }
    
    begin
      live = Uiza::Live.update params
      puts live.id
      puts live.name
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.live import Live
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    live_data = {
      "id": "471734b1-90b8-44c5-b24b-132ed9d7529b",
      "name": "live test",
      "mode": "pull",
      "encode": 0,
      "dvr": 1,
      "resourceMode": "single"
    }
    
    try:
      res, status_code = Live().update(**live_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "name" => "live test",
      "mode" => "pull",
      "encode" => 0,
      "dvr" => 1,
      "resourceMode" => "single"
    ];
    
    try {
      $live = Uiza\Live::update("471734b1-90b8-44c5-b24b-132ed9d7529b", $params);
    
      print_r($live);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Live;
    import io.uiza.model.Live.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("name", "live test");
        params.put("mode", Mode.PULL.toString());
        params.put("encode", Encode.NO_ENCODE.getVal());
        params.put("dvr", Dvr.ACTIVE_RECORD.getVal());
        params.put("resourceMode", ResourceMode.SINGLE.toString());
    
        try {
          JsonObject response = Live.update("471734b1-90b8-44c5-b24b-132ed9d7529b", params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '471734b1-90b8-44c5-b24b-132ed9d7529b',
      'name': 'live test',
      'mode': 'pull',
      'encode': 0,
      'dvr': 1,
      'resourceMode': 'single'
    };
    
    uiza.live.update(params)
      .then((res) => {
        //Identifier of event has been updated
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/live"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    dvrType := uiza.DvrTypeOne
    resourceMode := uiza.ResourceModeSingle
    params := &uiza.LiveUpdateParams{
      ID: uiza.String("471734b1-90b8-44c5-b24b-132ed9d7529b"),
      Name: uiza.String("live test"),
      Mode: uiza.String("pull"),
      Encode: 0,
      Dvr: 1,
      ResourceMode: uiza.String("single"),
    }
    response, err := live.Update(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Live.Update(new UpdateLiveParameter()
      {
        Id = "471734b1-90b8-44c5-b24b-132ed9d7529b",
        Name: "live test",
        Mode: "pull",
        Encode: 0,
        Dvr: 1,
        resourceMode: "single"
      });
    
      Console.WriteLine(string.Format("Update Category Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Updates the specified live event by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    RESPONSE

    {
      "id": "471734b1-90b8-44c5-b24b-132ed9d7529b"
    }
    

    HTTP Request

    PUT https://api.uiza.io/api/public/v4/live/entity

    ARGUMENTS

    Parameter Description Required
    id string The identifier of the live event Yes
    name string The event's name (limit 100 characters) Yes
    description string An arbitrary string attached to the object. Often useful for displaying to users. YES
    dvr integer Decides wether to record a live stream. If set to 1, a mp4 file will be created after the live stream ended. Set 0 to disable. YES
    mode string Type of event, allowed values [pull|push].
    Pull links can either be a RTMP URL or a .m3u8 URL or a live youtube link
    Push: Uiza will generate an end point. This end point can be used on Broadcasting softwares such as OBS to start your streaming.
    YES
    encode integer Set to 1 to enable live transcoding. Live transcoding will enable Adaptive Bitrate on the viewer's side which would help deliver a better viewing experience. When set to 0, viewers will watch with source bitrate. Yes
    resourceMode enum Resource mode ( single = only 1 feed & output), redundant = more than 1 feed & output to backup) Yes

    RETURNS

    Returns the ID of the updated live event if the update succeeded.

    Was this section helpful? Yes No

    Start a live feed

    REQUEST

    curl -X POST \
      'https://api.uiza.io/api/public/v4/live/entity/feed?id=471734b1-90b8-44c5-b24b-132ed9d7529b' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::Live.start_feed "471734b1-90b8-44c5-b24b-132ed9d7529b"
      puts response.message
      puts response.entityId
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.live import Live
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Live().start_feed(id="471734b1-90b8-44c5-b24b-132ed9d7529b")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $response = Uiza\Live::startFeed(["id" => "471734b1-90b8-44c5-b24b-132ed9d7529b"]);
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Live;
    import io.uiza.model.Live.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Live.startFeed("471734b1-90b8-44c5-b24b-132ed9d7529b");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '471734b1-90b8-44c5-b24b-132ed9d7529b'
    };
    
    uiza.live.start_feed(params)
      .then((res) => {
        // Identifier of event
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/live"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.LiveIDParams{ID: uiza.String("471734b1-90b8-44c5-b24b-132ed9d7529b")}
    response, err := live.StartFeed(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Live.StartFeed(new StartFeedParameter() {Id = "471734b1-90b8-44c5-b24b-132ed9d7529b"});
    
      Console.WriteLine(string.Format("Start Live Feed Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    pull mode: starting the live event will also start the live stream. push mode: after starting the live event, you can broadcast stream by using software such as OBS.

    RESPONSE

    {
      "message": "Start feed success",
      "entityId": "471734b1-90b8-44c5-b24b-132ed9d7529b"
    }
    

    HTTP Request

    POST https://api.uiza.io/api/public/v4/live/entity/feed

    ARGUMENTS

    Parameter Description Required
    id string The ID of the live event. Yes

    RETURNS

    Returns the ID of the live event if the start request succeeded.

    Was this section helpful? Yes No

    Stop a live feed

    REQUEST

    curl -X PUT \
      'https://api.uiza.io/api/public/v4/live/entity/feed?id=471734b1-90b8-44c5-b24b-132ed9d7529b' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::Live.stop_feed "471734b1-90b8-44c5-b24b-132ed9d7529b"
      puts response.message
      puts response.entityId
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.live import Live
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Live().stop_feed(id="471734b1-90b8-44c5-b24b-132ed9d7529b")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $response = Uiza\Live::stopFeed(["id" => "471734b1-90b8-44c5-b24b-132ed9d7529b"]);
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Live;
    import io.uiza.model.Live.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Live.stopFeed("471734b1-90b8-44c5-b24b-132ed9d7529b");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '471734b1-90b8-44c5-b24b-132ed9d7529b'
    };
    
    uiza.live.stop_feed(params)
      .then((res) => {
        // Identifier of event
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/live"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.LiveIDParams{ID: uiza.String("471734b1-90b8-44c5-b24b-132ed9d7529b")}
    response, err := live.StopFeed(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Live.StopFeed("471734b1-90b8-44c5-b24b-132ed9d7529b");
      Console.WriteLine(string.Format("Stop A Live Feed Success", result.Data.entityId));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Stop a live event. In push mode, stopping broadcasting from third party softwares won't stop the live event.

    RESPONSE

    {
      "message": "Stop feed success",
      "entityId": "471734b1-90b8-44c5-b24b-132ed9d7529b"
    }
    

    HTTP Request

    PUT https://api.uiza.io/api/public/v4/live/entity/feed

    ARGUMENTS

    Parameter Description Required
    id string The ID of the live event top stop. Yes

    RETURNS

    Returns the ID of the live event if the stop request succeeded.

    Was this section helpful? Yes No

    Retrieve views

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/live/entity/tracking/current-view?id=471734b1-90b8-44c5-b24b-132ed9d7529b' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::Live.get_view "471734b1-90b8-44c5-b24b-132ed9d7529b"
      puts response.watchnow
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.live import Live
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Live().get_view(id="471734b1-90b8-44c5-b24b-132ed9d7529b")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $response = Uiza\Live::getView(["id" => "471734b1-90b8-44c5-b24b-132ed9d7529b"]);
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Live;
    import io.uiza.model.Live.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Live.getView("471734b1-90b8-44c5-b24b-132ed9d7529b");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    uiza.live.get_view('471734b1-90b8-44c5-b24b-132ed9d7529b')
      .then((res) => {
        // Identifier of record (get from list record)
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/live"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.LiveIDParams{ID: uiza.String("471734b1-90b8-44c5-b24b-132ed9d7529b")}
    response, err := live.GetView(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    
    try
    {
      var result = UizaServices.Live.GetView("471734b1-90b8-44c5-b24b-132ed9d7529b");
    
      Console.WriteLine(string.Format("Get View Live Feed Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Retrieve the number of views of a running live event.

    RESPONSE

    {
      "stream_name": "peppa-pig-english-episodes",
      "watchnow": 1,
      "day": 1533271205999
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/live/entity/tracking/current-view

    ARGUMENTS

    Parameter Description Required
    id string The ID of the live event. Yes

    RETURNS

    Parameter Description
    stream_name string The event's name
    day number Timestamp of this view request
    watchnow number Current views of the live event

    Was this section helpful? Yes No

    List recorded files

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/live/entity/dvr' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      recordeds = Uiza::Live.list_recorded
      puts recordeds.first.id
      puts recordeds.first.entityId
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.live import Live
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Live().list_recorded()
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $recordeds = Uiza\Live::listRecorded();
    
      print_r($recordeds);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Live;
    import io.uiza.model.Live.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonArray response = Live.listRecorded();
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    uiza.live.list_recorded()
      .then((res) => {
        // Identifier of record
      }).catch((err) => {
        //Error
      });
    
    
    import (
      "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/live"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.LiveListRecordedParams{}
    
    response, err := live.ListRecorded(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Live.ListRecorded();
    
      Console.WriteLine(string.Format("Success Get List All Recorded Files, total record {0}", result.MetaData != null ? result.MetaData.total : 0));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Retrieves list of recorded file after streamed (only available when your live event has turned on Record feature)

    RESPONSE

    {
        "data": [
            {
                "id": "040df935-61c4-46f7-a41f-0a899ebaa2cc",
                "entityId": "ee122e85-553f-4621-bc77-1396191d5846",
                "channelName": "dcb8686f-d0f8-4a0f-8b92-22db339eb315",
                "feedId": "3e3b75df-e6fa-471c-b386-8f44b8a34b6c",
                "eventType": "pull",
                "startTime": "2018-12-13T16:28:29.000Z",
                "endTime": "2018-12-13T18:28:29.000Z",
                "length": "7200",
                "fileSize": "9276182",
                "extraInfo": null,
                "endpointConfig": "s3-uiza-dvr",
                "createdAt": "2018-12-13T19:28:43.000Z",
                "updatedAt": "2018-12-13T19:28:43.000Z",
                "entityName": "Christmas 2018 Holidays Special | Best Christmas Songs & Cartoons for Kids & Babies on Baby First TV"
            },
            {
                "id": "3fec45e9-932b-4efe-b97f-dc3053acaa05",
                "entityId": "47e804bc-d4e5-4442-8f1f-20341a156a70",
                "channelName": "e9034eac-4905-4f9a-8e79-c0bd67e49dd5",
                "feedId": "12830696-87e3-4209-a877-954f8f008964",
                "eventType": "pull",
                "startTime": "2018-12-13T14:14:14.000Z",
                "endTime": "2018-12-13T16:14:14.000Z",
                "length": "7200",
                "fileSize": "439858038",
                "extraInfo": null,
                "endpointConfig": "s3-uiza-dvr",
                "createdAt": "2018-12-13T17:30:42.000Z",
                "updatedAt": "2018-12-13T17:30:42.000Z",
                "entityName": "WATCH: SpaceX to Launch Falcon 9 Rocket #Spaceflight CRS16 @1:16pm EST"
            }
        ],
        "metadata": {
            "total": 2,
            "result": 2,
            "page": 1,
            "limit": 20
        }
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/live/entity/dvr

    RETURNS

    A dictionary with a data property that contains an array of up to limit recorded files. Each entry in the array is a separate recorded file object. If no more categories are available, the resulting array will be empty. This request should never return an error.

    Parameter Description
    id string The ID of the recorded file.
    entityId string Entity's ID corresponding to the record files.
    channelName string Name of channel.
    eventType string The mode of the event.
    startTime string Time start record.
    endTime string The time at which the live event was ended. The format is ISO 8601..
    length string The length of the recorded event.
    entityName string The entitiy's name, taken from live event's name.

    Was this section helpful? Yes No

    Delete a record file

    REQUEST

    curl -X DELETE \
      'https://api.uiza.io/api/public/v4/live/entity/dvr' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "92121a42-81d5-4364-8d5d-100799b34cd9"
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::Live.delete "92121a42-81d5-4364-8d5d-100799b34cd9" # Identifier of record (get from list record)
      puts response.id
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.live import Live
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Live().delete(id="92121a42-81d5-4364-8d5d-100799b34cd9") # Identifier of record (get from list record)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $response = Uiza\Live::delete("92121a42-81d5-4364-8d5d-100799b34cd9"); // Identifier of record (get from list record)
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Live;
    import io.uiza.model.Live.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Live.delete("92121a42-81d5-4364-8d5d-100799b34cd9"); // Identifier of record (get from list record)
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '92121a42-81d5-4364-8d5d-100799b34cd9'
    };
    
    uiza.live.delete(params) // Identifier of record (get from list record)
      .then((res) => {
        // Identifier of deleting a record
      }).catch((err) => {
        //Error
      });
    
    import (
      "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/live"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    param := &uiza.LiveIDParams{ID: uiza.String("92121a42-81d5-4364-8d5d-100799b34cd9")} // Identifier of record (get from list record)
    response, err := live.Delete(param)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.LiveStreaming.Delete("92121a42-81d5-4364-8d5d-100799b34cd9");
    
      Console.WriteLine(string.Format("Delete Live Feed Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Delete a recorded file

    RESPONSE

    {
      "id": "92121a42-81d5-4364-8d5d-100799b34cd9"
    }
    

    HTTP Request

    DELETE https://api.uiza.io/api/public/v4/live/entity/dvr

    ARGUMENTS

    Parameter Description
    id string The ID of recorded file taken from list record

    RETURNS

    Returns an ID of the deleted recorded file on success. Otherwise, this call returns an error.

    Was this section helpful? Yes No

    Convert into VOD

    REQUEST

    curl -X POST \
      'https://api.uiza.io/api/public/v4/live/entity/dvr/convert-to-vod?id=3fec45e9-932b-4efe-b97f-dc3053acaa05' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      live = Uiza::Live.convert_to_vod "21e513b1-43bf-4ce7-8cd0-692574563043" # Identifier of record (get from list record)
      puts live.id
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.live import Live
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Live().convert_into_vod(id="92121a42-81d5-4364-8d5d-100799b34cd9") # Identifier of record (get from list record)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $entity = Uiza\Live::convertToVOD(["id" => "92121a42-81d5-4364-8d5d-100799b34cd9"]); // Identifier of record (get from list record)
    
      print_r($entity);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Live;
    import io.uiza.model.Live.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Live.convertToVod("21e513b1-43bf-4ce7-8cd0-692574563043");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '21e513b1-43bf-4ce7-8cd0-692574563043'
    };
    
    uiza.live.convert_to_vod(params) // Identifier of record (get from list record)
      .then((res) => {
        // Identifier of record (get from list record)
      }).catch((err) => {
        //Error
      });
    
    import (
      "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/live"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    param := &uiza.LiveIDParams{ID: uiza.String("21e513b1-43bf-4ce7-8cd0-692574563043")} // Identifier of record (get from list record)
    response, err := live.ConvertToVOD(param)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Live.ConvertToVOD("21e513b1-43bf-4ce7-8cd0-692574563043");
    
      Console.WriteLine(string.Format("Convert VOD Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Convert a recorded file into entity.

    RESPONSE

    {
      "id": "03739912-d781-4d5a-aaf8-7262691a5d0c"
    }
    

    HTTP Request

    POST https://api.uiza.io/api/public/v4/live/entity/dvr/convert-to-vod

    ARGUMENTS

    Parameter Description
    id string The ID of recorded file taken from list record

    RETURNS

    Returns an ID of the entity on success. Otherwise, this call returns an error.

    Was this section helpful? Yes No

    Callback

    Uiza allows you to register callback (also known as Webhook) for entity.

    Example callback after create entity success

    {
      "text": "Your video was created successfully.",
      "id": "7fd1c81e-eecc-4aa1-8c7b-6aa647a468d9",
      "status": "Create success"
    }
    

    Example callback after publish entity success

    {
      "text": "Your video was published successfully.",
      "id": "7fd1c81e-eecc-4aa1-8c7b-6aa647a468d9",
      "status": "Entity publish success"
    }
    

    RETURNS

    Parameter Type Description
    id string The ID of entity that has been created or published.
    text string The JSON Data you put in callback.
    status enum Message contains additional information of the callback.

    Was this section helpful? Yes No

    Create a callback

    REQUEST

    curl -X POST \
      'https://api.uiza.io/api/public/v4/media/entity/callback' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "url": "https://callback-url.uiza.co",
        "method": "POST",
        "jsonData": {
          "data": "Example json data"
        },
        "headersData": {
          "data": "Example headers data"
        }
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      url: "https://callback-url.uiza.co",
      method: "POST",
      jsonData: {
        data: "Example json data"
      },
      headersData: {
        data: "Example headers data"
      }
    }
    
    begin
      callback = Uiza::Callback.create params
      puts callback.id
      puts callback.url
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.callback import Callback
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    callback_data = {
      "url": "https://callback-url.uiza.co",
      "method": "POST",
      "jsonData": {
        "data": "Example json data"
      },
      "headersData": {
        "data": "Example headers data"
      }
    }
    
    try:
      res, status_code = Callback().create(**callback_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "url" => "https://callback-url.uiza.co",
      "method" => "POST",
      "jsonData" => [
        "data" => "Example json data"
      ],
      "headersData" => [
        "data" => "Example headers data"
      ]
    ];
    
    try {
      $callback = Uiza\Callback::create($params);
    
      print_r($callback);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Callback;
    import io.uiza.model.Callback.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        JsonObject jsonData = new JsonObject();
        jsonData.addProperty("data", "Example json data");
    
        JsonObject headersData = new JsonObject();
        headersData.addProperty("data", "Example headers data");
    
        Map<String, Object> params = new HashMap<>();
        params.put("url", "https://callback-url.uiza.co");
        params.put("method", Method.POST);
        params.put("jsonData", jsonData);
        params.put("headersData", headersData);
    
        try {
          JsonObject response = Callback.create(params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'url': 'https://callback-url.uiza.co',
      'method': 'POST',
      'jsonData': {
        'data': 'Example json data'
      },
      'headersData': {
        'data': 'Example headers data'
      }
    };
    
    uiza.callback.create(params)
      .then((res) => {
        //Identifier of callback has been created
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/callback"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.CallbackCreateParams{
      Url:    uiza.String("https://callback-url.uiza.co"),
      Method: "POST",
      JsonData: {
        data: "Example json data"},
      HeadersData: {
        data: "Example headers data"},
      }
    
    response, err := callback.Create(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Callback.Create(new CreateCallbackParameter()
      {
        Url = "https://callback-url.uiza.co",
        Method = "POST",
        JsonData = {
          data = "Example json data"
        },
        HeadersData = {
          data = "Example headers data"
        }
      });
    
      Console.WriteLine(string.Format("Create New Callback Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    This API will allow you setup a callback to your server when an entity is completed for upload or public

    RESPONSE

    {
      "id": "56422bdf-95c8-42c7-8c52-1be99e732afa"
    }
    

    HTTP Request

    POST https://api.uiza.io/api/public/v4/media/entity/callback

    ARGUMENTS

    Parameter Description Required
    url string The callback URL. Yes
    method enum HTTP method of callback. Should only be POST or GET Yes
    jsonData object Extra data you want to attach when callback is called.
    headersData object The headers you want the callback to attach.

    RETURNS

    Returns a callback identifier if the call succeeded.

    Was this section helpful? Yes No

    Retrieve a callback

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/media/entity/callback' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "56422bdf-95c8-42c7-8c52-1be99e732afa"
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      callback = Uiza::Callback.retrieve "56422bdf-95c8-42c7-8c52-1be99e732afa"
      puts callback.id
      puts callback.url
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.callback import Callback
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Callback().retrieve(id="56422bdf-95c8-42c7-8c52-1be99e732afa")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $callback = Uiza\Callback::retrieve("56422bdf-95c8-42c7-8c52-1be99e732afa");
    
      print_r($callback);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Callback;
    import io.uiza.model.Callback.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Callback.retrieve("56422bdf-95c8-42c7-8c52-1be99e732afa");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    uiza.callback.retrieve()
      .then((res) => {
        //Identifier of callback has been retrieved
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/callback"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.CallbackIDParams{ID: uiza.String("56422bdf-95c8-42c7-8c52-1be99e732afa")}
    response, err := callback.Retrieve(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Callback.Retrieve("56422bdf-95c8-42c7-8c52-1be99e732afa");
    
      Console.WriteLine(string.Format("Get Callback Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Retrieves the details of an existing callback.

    RESPONSE

    {
      "id": "56422bdf-95c8-42c7-8c52-1be99e732afa",
      "url": "https://callback-url.uiza.co",
      "headersData": {
        "data": "Example headers data"
      },
      "jsonData": {
        "data": "Example json data"
      },
      "method": "POST",
      "status": 1,
      "createdAt": "2018-06-23T01:27:08.000Z",
      "updatedAt": "2018-06-23T01:27:08.000Z"
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/media/entity/callback

    ARGUMENTS

    Parameter Description Required
    id string The ID of the callback. Yes

    RETURNS

    Parameter Description
    id string The ID of the callback
    url string The callback URL.
    method enum The HTTP method of callback. Should only be POST or GET
    jsonData object Extra data you want to attach when callback is called.
    headersData object The headers you want the callback to attach.

    Was this section helpful? Yes No

    Update a callback

    REQUEST

    curl -X PUT \
      'https://api.uiza.io/api/public/v4/media/entity/callback' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "56422bdf-95c8-42c7-8c52-1be99e732afa",
        "url": "https://callback-url-update.uiza.co",
        "method": "POST",
        "jsonData": {
          "data": "Example json data updated"
        },
        "headersData": {
          "data": "Example headers data updated"
        }
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      id: "56422bdf-95c8-42c7-8c52-1be99e732afa",
      url: "https://callback-url-update.uiza.co",
      method: "POST",
      jsonData: {
        data: "Example json data updated"
      },
      headersData: {
        data: "Example headers data updated"
      }
    }
    
    begin
      callback = Uiza::Callback.update params
      puts callback.id
      puts callback.url
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.callback import Callback
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    callback_data = {
      "id": "56422bdf-95c8-42c7-8c52-1be99e732afa",
      "url": "https://callback-url-update.uiza.co",
      "method": "POST",
      "jsonData": {
        "data": "Example json data updated"
      },
      "headersData": {
        "data": "Example headers data updated"
      }
    }
    
    try:
      res, status_code = Callback().update(**callback_data)
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "url" => "https://callback-url-update.uiza.co",
      "method" => "POST",
      "jsonData" => [
        "data" => "Example json data updated"
      ],
      "headersData" => [
        "data" => "Example headers data updated"
      ]
    ];
    
    try {
      $callback = Uiza\Callback::update("56422bdf-95c8-42c7-8c52-1be99e732afa", $params);
    
      print_r($callback);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Callback;
    import io.uiza.model.Callback.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        JsonObject jsonData = new JsonObject();
        jsonData.addProperty("data", "Example json data updated");
    
        JsonObject headersData = new JsonObject();
        headersData.addProperty("data", "Example headers data updated");
    
        Map<String, Object> params = new HashMap<>();
        params.put("url", "https://callback-url-update.uiza.co");
        params.put("method", Method.POST);
        params.put("jsonData", jsonData);
        params.put("headersData", headersData);
    
        try {
          JsonObject response = Callback.update("56422bdf-95c8-42c7-8c52-1be99e732afa", params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '56422bdf-95c8-42c7-8c52-1be99e732afa',
      'url': 'https://callback-url-update.uiza.co',
      'method': 'POST',
      'jsonData': {
        'data': 'Example json data updated'
      },
      'headersData': {
        'data': 'Example headers data updated'
      }
    };
    
    uiza.callback.update(params)
      .then((res) => {
        //Identifier of callback has been updated
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/callback"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.CallbackUpdateParams{
      ID:    uiza.String("56422bdf-95c8-42c7-8c52-1be99e732afa"),
      Url:    uiza.String("https://callback-url-update.uiza.co"),
      Method: "POST",
      JsonData: {
        data: "Example json data updated"},
      HeadersData: {
        data:  "Example headers data updated"},
      }
    response, err := callback.Update(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Callback.Update(new UpdateCallbackParameter()
      {
        Id = "56422bdf-95c8-42c7-8c52-1be99e732afa",
        Url = "https://callback-url-update.uiza.co",
        Method = "POST",
        JsonData = {
          data = "Example json data updated"
        },
        HeadersData = {
          data = "Example headers data updated"}
        }
      });
    
      Console.WriteLine(string.Format("Update Callback Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Updates the specified callback by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    RESPONSE

    {
      "id": "56422bdf-95c8-42c7-8c52-1be99e732afa"
    }
    

    HTTP Request

    PUT https://api.uiza.io/api/public/v4/media/entity/callback

    ARGUMENTS

    Parameter Description Required
    id string The ID of the callback Yes
    url string The callback URL.
    method enum The HTTP method of callback. Should only be POST or GET
    jsonData object Extra data you want to attach when callback is called.
    headersData object The headers you want the callback to attach.

    RETURNS

    Returns the ID of the updated callback if the update succeeded.

    Was this section helpful? Yes No

    Delete a callback

    REQUEST

    curl -X DELETE \
      'https://api.uiza.io/api/public/v4/media/entity/callback' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "14a27ff9-869a-4969-a6d9-34220f01e48c"
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::Callback.delete "14a27ff9-869a-4969-a6d9-34220f01e48c"
      puts response.id
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.callback import Callback
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = Callback().delete(id="14a27ff9-869a-4969-a6d9-34220f01e48c")
    
      print("res: ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?php
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      $response = Uiza\Callback::delete("14a27ff9-869a-4969-a6d9-34220f01e48c");
    
      print_r($response);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.Callback;
    import io.uiza.model.Callback.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = Callback.delete("14a27ff9-869a-4969-a6d9-34220f01e48c");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '14a27ff9-869a-4969-a6d9-34220f01e48c'
    };
    
    uiza.callback.delete(params)
      .then((res) => {
        //Identifier of callback has been deleted
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/callback"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.CallbackIDParams{ID: uiza.String("14a27ff9-869a-4969-a6d9-34220f01e48c")}
    response, err := callback.Delete(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.Callback.Delete("14a27ff9-869a-4969-a6d9-34220f01e48c");
      Console.WriteLine(string.Format("Delete Callback Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    Delete an existing callback.

    RESPONSE

    {
      "id": "14a27ff9-869a-4969-a6d9-34220f01e48c"
    }
    

    HTTP Request

    DELETE https://api.uiza.io/api/public/v4/media/entity/callback

    ARGUMENTS

    Parameter Description Required
    id string The ID of the callback to be deleted. Yes

    RETURNS

    Returns an ID of the deleted callback on success. Otherwise, this call returns an error.

    Was this section helpful? Yes No

    User Management

    You can manage user with APIs user. Uiza have 2 levels of user

    Admin - This account will have the highest priority, can have permission to create & manage users.

    User - This account level is under Admin level. It only manages APIs that relates to this account.

    Was this section helpful? Yes No

    Retrieve an user

    Retrieves the details of an existing user. You need only supply the unique userId that was returned upon user creation.

    REQUEST

    curl -X GET \
      'https://api.uiza.io/api/public/v4/admin/user?id=508d46b7-afa7-45e7-8141-fdeafe32a4cc' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      user = Uiza::User.retrieve "508d46b7-afa7-45e7-8141-fdeafe32a4cc"
      puts user.id
      puts user.username
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.user import User
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = User().retrieve(id="508d46b7-afa7-45e7-8141-fdeafe32a4cc")
    
      print("res ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      Uiza\User::retrieve("508d46b7-afa7-45e7-8141-fdeafe32a4cc");
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.User;
    import io.uiza.model.User.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = User.retrieve("508d46b7-afa7-45e7-8141-fdeafe32a4cc");
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '508d46b7-afa7-45e7-8141-fdeafe32a4cc'
    };
    
    uiza.user.retrieve(params)
      .then((res) => {
        // Identifier of user
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/user"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.UserIDParams{ID: uiza.String("508d46b7-afa7-45e7-8141-fdeafe32a4cc")}
    response, err := user.Retrieve(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.User.Retrieve("508d46b7-afa7-45e7-8141-fdeafe32a4cc");
    
      Console.WriteLine(string.Format("Get User Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    RESPONSE

    {
      "id": "508d46b7-afa7-45e7-8141-fdeafe32a4cc",
      "isAdmin": 1,
      "username": "user_test",
      "email": "user_test@uiza.io",
      "updatedAt": "2018-06-22T18:05:47.000Z",
      "createdAt": "2018-06-22T18:05:47.000Z"
    }
    

    HTTP Request

    GET https://api.uiza.io/api/public/v4/admin/user

    Header Type Description Required

    ARGUMENTS

    Parameter Type Description Required
    id string Identifier of user Yes

    RETURNS

    Parameter Type Description
    id string Identifier of user
    isAdmin number Determine role admin of user (0 = Yes, 1 = No)
    username string Username of account (used for login instead of email)
    email string Email (used for login instead of username)
    createdAt datetime Time created user
    updatedAt datetime Last edited time of user

    Was this section helpful? Yes No

    Update an user

    Updates the specified user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    REQUEST

    curl -X PUT \
      'https://api.uiza.io/api/public/v4/admin/user' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1' \
      -H 'Content-Type: application/json' \
      -d '{
        "id": "508d46b7-afa7-45e7-8141-fdeafe32a4cc",
        "status": 0,
        "username": "user_test",
        "email": "user_test@uiza.io",
        "avatar": "https://exemple.com/avatar.jpeg",
        "fullname": "User Test",
        "dob": "2000-12-30",
        "gender": 0,
        "password": "123456789",
        "isAdmin": 1
    }'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    params = {
      id: "508d46b7-afa7-45e7-8141-fdeafe32a4cc",
      status: 1,
      username: "user_test",
      email: "user_test@uiza.io",
      avatar: "https://exemple.com/avatar.jpeg",
      fullname: "User Test",
      dob: "2000-12-30",
      gender: 0,
      password: "123456789",
      isAdmin: 1
    }
    
    begin
      user = Uiza::User.update params
      puts user.id
      puts user.username
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.user import User
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    
    user_data = {
      "id": "508d46b7-afa7-45e7-8141-fdeafe32a4cc",
      "status": 1,
      "username": "user_test",
      "email": "user_test@uiza.io",
      "avatar": "https://exemple.com/avatar.jpeg",
      "fullname": "User Test",
      "dob": "2000-12-30",
      "gender": 0,
      "password": "123456789",
      "isAdmin": 1
    }
    
    try:
      res, status_code = User().update(**user_data)
    
      print("res ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    $params = [
      "status" => 1,
      "username" => "user_test",
      "email" => "user_test@uiza.io",
      "avatar" => "https://exemple.com/avatar.jpeg",
      "fullname" => "User Test",
      "dob" => "2000-12-30",
      "gender" => 0,
      "password" => "123456789",
      "isAdmin" => 1
    ];
    
    try {
      Uiza\User::update("508d46b7-afa7-45e7-8141-fdeafe32a4cc", $params);
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.User;
    import io.uiza.model.User.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        Map<String, Object> params = new HashMap<>();
        params.put("status", Status.ACTIVE.getVal());
        params.put("username", "user_test");
        params.put("email", "user_test@uiza.io");
        params.put("avatar", "https://exemple.com/avatar.jpeg");
        params.put("fullname", "User Test");
        params.put("dob", "2000-12-30");
        params.put("gender", 0);
        params.put("password", "123456789");
        params.put("isAdmin", 1);
    
        try {
          JsonObject response = User.update("<user-id>", params);
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    const params = {
      'id': '508d46b7-afa7-45e7-8141-fdeafe32a4cc',
      'status': 1,
      'username': 'user_test',
      'email': 'user_test@uiza.io',
      'avatar': 'https://exemple.com/avatar.jpeg',
      'fullname': 'User Test',
      'dob': '2000-12-30',
      'gender': 0,
      'password': '123456789',
      'isAdmin': 1
    };
    
    uiza.user.update(params)
      .then((res) => {
        // Identifier of user wanted to update
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/user"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.UserUpdateParams{
      ID: uiza.String("508d46b7-afa7-45e7-8141-fdeafe32a4cc"),
      Status: uiza.Int64(1),
      Username: uiza.String("user_test"),
      Email: uiza.String("user_test@uiza.io"),
      Avatar: uiza.String("https://exemple.com/avatar1.jpeg"),
      Fullname: uiza.String("User Test"),
      Dob: uiza.String("2000-12-30"),
      Gender: uiza.Int64(0),
      Password: uiza.String("123456789"),
      IsAdmin: uiza.Int64(1),
    }
    response, err := user.Update(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.User.Update(new UpdateUserParameter()
      {
        Id = "508d46b7-afa7-45e7-8141-fdeafe32a4cc",
        Status = 1,
        UserName = "user_test",
        Email = "user_test@uiza.io",
        Avatar = "https://exemple.com/avatar.jpeg",
        FullName = "User Test",
        DOB = "2000-12-30",
        Gender = 0,
        Password = "123456789",
        IsAdmin = 1
      });
    
      Console.WriteLine(string.Format("Update User Id = {0} Success", result.Data.id));
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    RESPONSE

    {
      "id": "508d46b7-afa7-45e7-8141-fdeafe32a4cc",
      "isAdmin": 1,
      "username": "user_test",
      "email": "user_test@uiza.io",
      "updatedAt": "2018-06-22T00:00:00.000Z",
      "createdAt": "2018-06-22T18:05:47.000Z"
    }
    

    HTTP Request

    PUT https://api.uiza.io/api/public/v4/admin/user

    ARGUMENTS

    Parameter Description Required
    id string Identifier of user wanted to update Yes
    status integer Status of account ( 0 = de-active, 1 = active) Yes
    username string Username of account (used for login instead of email) Yes
    email string Email (used for login instead of username) Yes
    password text Password (from a to Z, 6 to 25 characters) Yes
    avatar string Link of avatar (suggest 300x300)
    fullname string Full name of user
    dob date Date of birth (MM/DD/YYYY)
    gender integer Gender ( 0 = Male, 1 = Female)
    isAdmin integer Set this account isAdmin or not (1 = Yes, 0 = No)

    RETURNS

    Returns the user object if the update succeeded.

    Was this section helpful? Yes No

    Log Out

    This API use to log out an user. After logged out, token will be removed.

    REQUEST

    curl -X POST \
      'https://api.uiza.io/api/public/v4/admin/user/logout' \
      -H 'Authorization: uap-212f8ac7dcc7471c936babf43a1a252e-57078be1'
    
    require "uiza"
    
    Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    begin
      response = Uiza::User.logout
      puts response.message
    rescue Uiza::Error::UizaError => e
      puts "description_link: #{e.description_link}"
      puts "code: #{e.code}"
      puts "message: #{e.message}"
    rescue StandardError => e
      puts "message: #{e.message}"
    end
    
    import uiza
    
    from uiza.api_resources.user import User
    from uiza.exceptions import ServerException
    
    uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    
    try:
      res, status_code = User().logout()
    
      print("res ", res)
    except ServerException as e:
      raise e
    except Exception as e:
      raise e
    
    <?
    require __DIR__."/../vendor/autoload.php";
    
    Uiza\Base::setAuthorization("uap-212f8ac7dcc7471c936babf43a1a252e-57078be1");
    
    try {
      Uiza\User::logOut();
    } catch(\Uiza\Exception\ErrorResponse $e) {
      print($e);
    }
    ?>
    
    import java.util.*;
    import com.google.gson.*;
    
    import io.uiza.Uiza;
    import io.uiza.exception.*;
    import io.uiza.model.User;
    import io.uiza.model.User.*;
    
    public class Main {
    
      public static void main(String[] args) {
        Uiza.authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1";
    
        try {
          JsonObject response = User.logout();
          System.out.println(response);
        } catch (UizaException e) {
          System.out.println("Status is: " + e.getStatusCode());
          System.out.println("Message is: " + e.getMessage());
          System.out.println("Description link is: " + e.getDescriptionLink());
        } catch (Exception e) {
          System.out.println(e);
        }
      }
    }
    
    const uiza = require('uiza');
    
    uiza.authorization('uap-212f8ac7dcc7471c936babf43a1a252e-57078be1');
    
    uiza.user.log_out()
      .then((res) => {
        // Identifier of task publish
      }).catch((err) => {
        //Error
      });
    
    import (
      uiza "github.com/uizaio/api-wrapper-go"
      "github.com/uizaio/api-wrapper-go/user"
    )
    
    func init() {
      Uiza.Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    }
    
    params := &uiza.UserIDParams{}
    response, err := user.LogOut(params)
    if err != nil {
      log.Printf("%v\n", err)
    } else {
      log.Printf("%v\n", response)
    }
    
    using System;
    using Uiza.Net.Configuration;
    using Uiza.Net.Enums;
    using Uiza.Net.Parameters;
    using Uiza.Net.Services;
    
    UizaConfiguration.SetupUiza(new UizaConfigOptions
    {
      Authorization = "uap-212f8ac7dcc7471c936babf43a1a252e-57078be1"
    });
    
    try
    {
      var result = UizaServices.User.Logout();
      Console.WriteLine("Logout Success");
      Console.ReadLine();
    }
    catch (UizaException ex)
    {
      Console.WriteLine(ex.Message);
      Console.ReadLine();
    }
    

    RESPONSE

    {
      "message": "Logout success"
    }
    

    HTTP Request

    POST https://api.uiza.io/api/public/v4/admin/user/logout

    RETURNS

    A message indicating status of the logout request.

    Was this section helpful? Yes No

    Embed Metadata

    Embed metadata is information that can be embed into video/audio file. You can embed into file by adding a json compose these tag.

    "embedData": {
         "title": "Despacito",
         "artist": "Luis Fonsi",
         "album_artist": "",
         "album": "",
         "composer": "",
         "year": "2017",
         "track": null,
         "genre": "Nhạc trẻ",
         "description": null,
         "copyright": "Universal Music Latino",
         "network": null,
         "show": null,
         "episode_id": null
    }
    

    Note

    To keep embedData of source file, tag value will be null

    To remove embedData of source file, tag value will be a string without value ""

    Tag list

    Tags Type Description
    title string Title of video/audio
    artist string Name of artist
    album_artist string Artist of album
    album string Name of album
    composer string Name of composer
    year int(4) Published year
    track int Order of track in album
    genre string Genre
    description string Video/Audio's description
    copyright string
    network string Network channel
    show string Name of show
    episode_id int Episode number

    Was this section helpful? Yes No

    Change log

    Date Version Change log
    31/03/2019 4.0.0 Uiza is now running on version 4. We also overhauled the documentation to help you use our API easier.
    19/12/2018 3.0.9 add DVR option to API create live
    18/12/2018 3.0.8 fix typo for API get status publish
    27/11/2018 3.0.7 add API analytic
    05/10/2018 3.0.6 add linkPublishSocial to Event live
    06/09/2018 3.0.5 Add callback function
    04/09/2018 3.0.4 Add parameter publishToCdn for VOD
    07/08/2018 3.0.3 Update API get AWS Upload key
    03/08/2018 3.0.2 Change naming metadata to category
    30/07/2018 3.0.1 Add metadataIds while create entity
    14/06/2018 3.0.0 Release API docs for version 3

    Was this section helpful? Yes No