4publishing2.jpeg

Marevo company

Multi-category app

Requirements for JSON files for

an EF Covering powered app

General

The current specification is about how the EF Covering AR app receives data from the Client's server.
In case you need to discuss these requirements, please, contact the manager you communicate with.

It's planned to get 2 separate JSON-files:

  • Content - a file with listed items and their params.

  • Filter - a file with listed filters and their values.

Each file contains the last update time.
The Client provides the files.

The app uses GET-requests.
It's planned to be 2 separate requests of the following type:
https://site.com/?key=securekey&type=contenttype

  • Site.com - URL for request.

  • Securekey - the random range of characters. The Client provides the key.

  • Type - a type of JSON-files the app intends to get (filters, content)

  • The protocol must be https.

Content file

Variable
Description
Example
Сategory_id
Id of Item category
"1" or "Floor"
Сategory_name
Name of Item category
"Floor"
Item_list*
List of items from the category. Array
Item_id*
Unique item identifier
SuperTile_22343929
Item_update_date*
Last update date
2020-08-31 11:00:06
Item_name*
Item title
Betap Carnival
Item_link
Link to the item page on a website
https://site.com/tiles/23095
Item_image*
An array of links to item images. The first image is used as the main.
“Item_image”: ["https://site.com/images/23095.jpg”, “https://site.com/images/23095.jpg”]
Item_price
Price of the item in a specified currency
135.00
Item_type*
Type of AR content. There are only 3 types: “floor”, “wall”, “3D”
floor
Item_texture*
(only for “floor”, “wall”) An array of links to item texture images. All images must have the same size.
“Item_texture”: ["https://site.com/textures/23095_t1.jpg”, “https://site.com/textures/23095_t2.jpg”]
Item_texture_size*
(only for “floor”, “wall”). Size (in meters) of the bigger side of the texture. The smaller one is estimated automatically Be mindful, that it isn't the size of 1 tile but the size of all tiles (+seams width) which are placed on one piece of texture.
0.45
Item_finishing
(only for “floor”, “wall”) Level of the shine of a texture. The value is from 0 (matt) to 1 (polished). The default value is 0.5
0.67
Item_model*
(only for “3D”) Link to a 3D model. The required format is GLB
https://site.com/images/2309.glb
Item_Description
Text information about the item
“The best outdoor floor tile in North Kyiv”
Item_Specification
List of item characteristics and their values. Values are divided by comma. Warning. Names of item characteristics and their values have to coincident with names and values in filters. Otherwise, items won't be present in filter results.
“Item_Specification”: [{“Name” : “Color ”, “Value” : “White, blue, dark blue”}, {“Name” : “Country”,“Value” : “Italy”}]

- Variables with * are mandatory
- All the links have to be "https"
- All variables have the "string" type

Content JSON example

{
    “Content” : 
    [
        {
            "Category_id" : "1",
            "Category_name" : "Floor tile",
            "Item_list" :
            [
                {         
             “Item_id” : “SuperTile_22343929”, 
             “Item_update_date” : “2020-08-31 11:00:06”,
             “Item_name” : “Betap Carnival”, 
             “Item_image” : ["https://site.com/images/23095.jpg", "https://site.com/images/23095.jpg"],
             “Item_category” : “Floor”,
             “Item_price” : “135.00”,
             “Item_type” : “floor”, 
             “Item_texture” : ["https://site.com/textures/23095_t1.jpg", "https://site.com/textures/23095_t2.jpg"],
             “Item_texture_size” : “0.45”,
             “Item_finishing” : “0.67”, 
              “Item_Description” : “The best outdoor floor tile in North Kyiv”, 
             “Item_Specification” : 
           [
           {
               “Name” : “Color ”,
               “Value” :  “white, blue, dark blue”
           },
           {
               “Name” : “Country”,
               “Value” :  “Italy”
           },
           {
               “Name” : “Collection ”,
               “Value” :  “Venice”
           }
           ]
       }
            ]       
        }
    ]
}

Filters

Varialbe
Description
Example
File_update_date
Last update date
2020-08-31 11:00:06
Category_id
Category id of the filter
"1"
Category_name
Category name of the filter
"Floor"
Filter_list
Array of pairs: characteristic - value(s)
[ { “Filter_name” : “color”, “Filter_value” : [“white”, “green”,”red”] }]
Filter_name
Filter name
color
Filter_value
Array of the characteristic values
[“polish”, “matt”]

Filter JSON example

{
“File_update_date” : “2020-08-31 11:00:06”
“Filter”:
      [
            {
            “Category_id” : “1”,
            “Category_name” : “Floor”,
            “Filter_list” : 
               [ 
                       {
                          “Filter_name” : “Color”,
                          “Filter_value” : ["white", "green","red"]
                       },
                       {
                          “Filter_name” : “Finishing”,
                          “Filter_value” : ["polish", "matt"]
                       }
                ]
            },
            {
            “Category_id” : “2”,           
            “Category_name” : “Wall”,
            “Filter_list” : 
              [ 
                       {
                          “Filter_name” : “Color”,
                          “Filter_value” : ["white", "green","pink"]
                       },
                       {
                          “Filter_name” : “Type”,
                          “Filter_value” : [“Wall paper”, “Paint”]
                       }
                ]
            }
      ]
}