7. CMS Service

You can purchase contents from the Content Shop in the ARGear Console (https://console.argear.io) and manage them to fit your needs.

To use the purchased products, you need to first create a category in the Content Management menu. For each category, you can add or remove purchased products. You can also get the list of the products in each category through Project Overview > API > Your API URL.

<Fig. Your API URL>

7.1 Request URL Format

The request URL format is written as follows:

<Sample Code. Request URL Format>

Format : https:// + API_URL + “/api/v3/” + API_KEY
Example : https://13.125.98.252:3001/api/v3/362ef06e0cfd2734db067f51

7.2 Returning Data JSON Format

The requested URL above returns JSON string as follows:

<Sample JSON Format>

{
   "api_key": "fe49fe8fe8c757e5a4f8d48d",
   "name": "",
   "description": "",
   "status": "LIVE",
   "categories": [
       {
           "uuid": "9914e791-0ad4-11ea-963e-d96ec44fac5d",
           "slot_no": 0,
           "title": "stickers",
           "description": "",
           "is_bundle": false,
           "updated_at": 1574171880585,
           "items": [
               {
                   "uuid": "f9a91f00-d39c-11e9-a9a4-bb27b8db75ec",
                   "title": "KT_2DMASK_35",
                   "description": "",
                   "thumbnail": "https://content.argear.io/thumbnails/f9a91f00-d39c-11e9-a9a4-bb27b8db75ec.png",
                   "zip_file": "https://privatecontent.argear.io/contents/data/f9a91f00-d39c-11e9-a9a4-bb27b8db75ec.zip",
                   "num_stickers": 0,
                   "num_effects": 0,
                   "num_bgms": 0,
                   "num_filters": 1,
                   "num_masks": 1,
                   "has_trigger": false,
                   "status": "LIVE",
                   "updated_at": 1574145649708,
                   "big_thumbnail": "https://content.argear.io/thumbnails/f9a91f00-d39c-11e9-a9a4-bb27b8db75ec_big_thumbnail.png",
                   "type": "sticker/effects"
               },
               {
                   "uuid": "9a1f9c50-e04c-11e9-bd52-1de54418b8eb",
                   "title": "KT_2DMASK_37",
                   "description": "",
                   "thumbnail": "https://content.argear.io/thumbnails/9a1f9c50-e04c-11e9-bd52-1de54418b8eb.png",
                   "zip_file": "https://privatecontent.argear.io/contents/data/9a1f9c50-e04c-11e9-bd52-1de54418b8eb.zip",
                   "num_stickers": 0,
                   "num_effects": 0,
                   "num_bgms": 0,
                   "num_filters": 0,
                   "num_masks": 1,
                   "has_trigger": false,
                   "status": "LIVE",
                   "updated_at": 1574145626152,
                   "big_thumbnail": "https://content.argear.io/thumbnails/9a1f9c50-e04c-11e9-bd52-1de54418b8eb_big_thumbnail.png",
                   "type": "sticker/effects"
               }
           ],
           "division": 0,
           "level": 0,
           "status": "LIVE",
           "countries": null,
           "parentCategoryUuid": null
       },
       {
           "uuid": "9914c080-0ad4-11ea-963e-d96ec44fac5d",
           "slot_no": 1,
           "title": "filters",
           "description": "filters",
           "is_bundle": false,
           "updated_at": 1574171880585,
           "items": [
               {
                   "uuid": "b2b32470-f470-11e9-874d-b725998306ad",
                   "title": "sand",
                   "description": "",
                   "thumbnail": "https://content.argear.io/thumbnails/b2b32470-f470-11e9-874d-b725998306ad.png",
                   "zip_file": "https://privatecontent.argear.io/contents/data/b2b32470-f470-11e9-874d-b725998306ad.zip",
                   "num_stickers": 0,
                   "num_effects": 0,
                   "num_bgms": 0,
                   "num_filters": 1,
                   "num_masks": 0,
                   "has_trigger": false,
                   "status": "LIVE",
                   "updated_at": 1574160539636,
                   "big_thumbnail": "https://content.argear.io/thumbnails/b2b32470-f470-11e9-874d-b725998306ad_big_thumbnail.png",
                   "type": "filter"
               }
           ],
           "division": 1,
           "level": 0,
           "status": "LIVE",
           "countries": null,
           "parentCategoryUuid": null
       }
   ],
   "last_updated_at": 1574171817392
}

7.3 Details of JSON Format (Contents List Search)

The tables below describe JSON formats when calling REST API through CMS.

The Top Layer JSON Format

<Table. Top Layer>

key	type	description
api_key	string	API KEY of ARGear Console Project
name	string	name of contents
description	string	description of contents
status	string	status of contents (LIVE, STAGING)
last_updated_at	long	last updated time of the contents list
categories	list	list of categories

categories JSON Format

<Table. API categories / filters>

key	type	description
uuid	string	uuid
title	string	title
description	string	description
is_bundle	boolean	true : default provided categories/filters false : user added categories/filters
updated_at	long	updated time
status	string	status (LIVE, STAGING)
items	list	list of items

items JSON Format

<Table. API Items>

key	type	description
uuid	string	uuid
title	string	title
description	string	description
thumbnail	string	thumbnail url
zip_file	string	url of downloaded file
num_stickers	int	number of stickers in an item
num_effects	int	number of effects in an item
num_bgms	int	number of bgms in an item
num_filters	int	number of filters in an item
num_masks	int	number of masks in an item
has_trigger	boolean	indicates whether an item contains a trigger. true : The item contains a trigger. false : The item does not contain a trigger.
status	string	status of an item (LIVE, STAGING)
updated_at	long	last updated time of an item
type	string	type of an item