Widgets and Sections

Type Description Can be edited by source
popup Show a popup message Yes
title A title, for example, a product name Yes
header A screen's title Yes
text A text information, it's rich format ( Markdown) Yes
image One or more images Yes
link A link Yes
video A video Yes
status A product's status No
warranty A button to start a warranty process No
receipt_store A button to start a receipt storing process No
nutrition_info Nutrition facts Yes
certificates A list of certificates Yes
rewards_summary A summary information about possible rewards points on a screen No
live_chat A button to start a live chat session No
follow_fb Follow brand on the Facebook Yes
email Send an email message (to support, as an example) Yes
phone Call to a phone number Yes
rating Rate a product No
add_image Add a new image No
field A form's field No
gdti Link to existing GDTI document Yes

It shows a popup message when the section becomes “available” in the list.

Option Description
icon Predefined icon's ID (list of IDs: “action”,“brand”,“contact”,“fb”,“support”,“verify”,“warning”) or an image URL)
title A message title
text A text information in a rich format (Markdown)
ok A text of an OK button
cancel A text of a cancel button. If an user touch that button a product information screen should be closed
{
  "popup": {
    "icon": "action",
    "title": "You discovered a new product",
    "text": "We don't have information about this product in our DB. Complete product's details to earn **50 points**.",
    "ok": "Add product",
    "cancel": "Not now"
  }
}

Popup section

Title

It shows a title (short text).

Option Description
text A text information
{
  "title": {
    "text": "Nike Men's KB Mentality II"
  }
}

Title section

It defines a screen's title/header.

Option Description
text A header's text
{
  "header": {
    "text": "How it works?"
  }
}

Header section

Text

It shows a text block with rich format (Markdown).

Option Description
title A block title (optional)
text A text information
markdown a boolean flag indicating the text in markdown format or not (when true - is markdown format)
{
  "text": {
    "title": "Traceability & Serialisation Platform",
    "text": "Bla-bla-bla.",
    "markdown": true
  }
}

Text section

Image

It shows one or more images.

Option Description
url Image's source.
{
  "image": [
    {
      "url": "https://services.authenticateit.com/upload/991be8ee/2fb7-4392-9f20-b2d272b0faea.jpeg"
    },
    {
      "url": "https://services.authenticateit.com/upload/991be8ee/6788-7868-6786-bc9900900086.jpeg"
    }
  ]
}

Image section

It shows a link to internet resource.

Option Description
text A text that will be shown
url A link
{
  "link": {
    "text": "Brand web site",
    "url": "http://www.koalabi.com.au"
  }
}

Video

A video content that can be viewed at place or in fullscreen modes.

Option Description
title A video title
url A video source
preview A video's preview image
height A video's height (optional) will be added if video was uploaded with upload-service
width A video's width (optional) will be added if video was uploaded with upload-service
{
  "video": {
    "preview": "https://services.authenticateit.com/upload/991be8ee/movie.jpg",
    "title": "Video",
    "url": "https://dev-test-cdn.shping.com.s3.amazonaws.com/2017/4/26/1fe6501e-7ea2-4e99-a0f8-481ac3f24274-20100709_002.mp4",
    "height": 480,
    "width": 848
  }
}

Video section

Status

A product's status with additional information

Option Description
icon A predefined icon's id or URL
title A status
description A status's description
info A GDTI code that can be used for requesting additional information
action A button for starting additional workflow. Text and predefined ID, if a mobile app does not know that ID then it will not shown
extension Additional information

Extension:

Option Description
title A title
map Show map (default is false
history A list of records with the following attributes: date, status, location, from, to
{
  "status": {
    "icon": "checked",
    "title": "Not recalled",
    "description": "According Authenticateit DB",
    "info": "25393777790007798768"
  }
}

Not recalled

{
  "status": {
    "icon": "warning",
    "title": "Warning",
    "description": "This type of products has been recalled in the past. Check recalls history to make sure your product is safe.",
    "extension": {
      "title": "Recalls history",
      "history": [
        {
          "date": "2016-01-01",
          "location": "USA"
        },
        {
          "date": "2016-01-01",
          "location": "Australia"
        }
      ]
    }
  }
}

Warning

{
  "status": {
    "icon": "failed",
    "title": "This product is not authentic!",
    "description": "Verified by Global Traceability Platform",
    "info": "25393777790007798768"
  }
}

Failed

{
  "status": {
    "icon": "authentic",
    "title": "This product is authentic",
    "description": "Verified by Global Traceability Platform",
    "info": "25393777790007798768",
    "extension": {
      "title": "Trace product",
      "map": true,
      "history": [
        {
          "date": "2016-01-01",
          "status": "Production",
          "location": "Melbourne"
        },
        {
          "date": "2016-01-02",
          "status": "Export",
          "location": "Melbourne"
        },
        {
          "date": "2016-01-03",
          "status": "Import",
          "location": "China",
          "from": "036",
          "to": "156"
        },
        {
          "date": "2016-01-04",
          "status": "Distribution",
          "location": "China"
        },
        {
          "date": "2016-01-05",
          "status": "Wal-Mart",
          "location": "China Beijing"
        }
      ]
    }
  }
}

Authentic

{
  "status": {
    "icon": "unknown",
    "info": "25393777790007798768",
    "action": {
      "text": "Verify authenticity of your purchase",
      "workflow": "authenticity_check"
    }
  }
}

Default GDTI status document

{
  "id": "25393777790007798768",
  "name": "Default Status GDTI document",
  "owner": "urn:authenticateit:participant:1",
  "sources": [
    {
      "conditions": {},
      "data": [
        {
          "text": {
            "markdown": false,
            "text": "Shping is a powerful new tool to enable consumers and brands to work together to identify and stop the sale of counterfeit products and unauthorised imports in legitimate retail situations. Shping is a smartphone application that empowers consumers with a fast and convenient way to check an item’s authenticity before purchase, effectively removing the threat of purchasing a counterfeit product. The comprehensive brand protection solution is build with an advance track and trace system at the back end, whilst the front end of the Shping system is a smartphone application that provides consumers with a free, easy way to check an item’s authenticity prior to purchase. The entire Shping system utilises the GS1 barcode technology as identifiers. The smartphone application is free to download and can be used by consumers to authenticate the goods of participating brands in retail and online situations.",
            "title": "About Us"
          }
        }
      ]
    }
  ],
  "type": "general_doc"
}

Unknown

Warranty

A button to start a warranty process

Option Description
pid Participant ID
sgtin SGTIN
name Product name
manufacturer_warranty Manufacturer Warranty (months)
extended_warranty Extended Warranty (months)
{
  "warranty": {
    "pid": "a89d547fcbb8d0b5790b7d7f561f129c",
    "sgtin": "010934233622222221000000000000009",
    "name": "Nike Men's KB",
    "manufacturer_warranty": 24,
    "extended_warranty": 0
  }
}

Warranty section

Receipt store

A button to start a receipt storing process

Option Description
code Scanned code
name Product name
{
  "receipt_store": {
    "code": "9342336222222",
    "name": "Nike Men's KB"
  }
}

Receipt section

Nutrition info

It shows a nutrition information

Option Description
title A widget title
package_unit Product's package units
package_value Package value
serving_size Serving size
serving_energy Serving energy (Calories)
nutrition_staff Information about nutrition staff
ingredients List of ingredients
{
  "nutrition_info": {
    "title": "Nutrition Facts",
    "package_unit": "ml",
    "package_size": 1000,
    "serving_size": 200,
    "serving_energy": 100,
    "nutrition_staff": [
      {
        "name": "Protein",
        "unit": "g",
        "value": 10,
        "rdi": 64,
        "less_than": false
      },
      {
        "name": "Fat, total",
        "unit": "g",
        "value": 2,
        "less_than": false,
        "nutrition_staff": [
          {
            "name": "Saturated",
            "unit": "g",
            "value": 0.1,
            "less_than": true
          },
          {
            "name": "Omega 3",
            "unit": "g",
            "value": 1,
            "less_than": false
          }
        ]
      }
    ],
    "ingredients": [
      {
        "name": "Витамин С/Аскорбиновая кислота (в форме кальция аскорбата) 110 мг 120",
        "description": "long text description of the ingredient",
        "nano": false,
        "allergen": false,
        "group": "vitamins"
      },
      {
        "name": "Rice",
        "description": "long text description of the ingredient",
        "nano": false,
        "allergen": false,
        "group": "other"
      }
    ]
  }
}

Nutrition info section

Certificates

List of certificates

Option Description
title List's title (expert/certificator name)
list Certificates, where each item has the following attributes: img_url, cid (certificate id), expired
{
  "certificates": {
    "title": "Certificates",
    "list": [
      {
        "img_url": "https://services.authenticateit.com/upload/20160831/asureq.png",
        "cid": "a89d547fcbb8d0b5790b7d7f561f129c",
        "expired": false
      },
      {
        "img_url": "https://services.authenticateit.com/upload/20160831/aco.png",
        "cid": "a89d547fcbb8d0b5790b7d7f561f1786",
        "expired": true
      }
    ]
  }
}

Certificates section

Rewards summary

It shows a total rewards points that can be earn on the screen and a progress bar.

Option Description
points Number of total points
{
  "rewards_summary": {
    "points": 10
  }
}

Rewards summary section

Live chat

It shows a link to start a live chat session

Option Description
text A text that will be shown
cid A participant id
type A type of participant
{
  "live_chat": {
    "text": "Click here to start a support chat",
    "cid": "urn:authenticateit:participant:2489226097599",
    "type": "brand"
  }
}

Live chat section

Follow FB

It shows a link to a brand's FB page.

Option Description
text A text that will be shown
url A fb link
{
  "follow_fb": {
    "text": "Follow us",
    "url": "https://www.facebook.com/NorcoMilk/"
  }
}

Follow FB section

Email

It shows a link to open mail app with predefined fields To and Subject.

Option Description
text A text that will be shown
to A recipient email
subject A subject
{
  "email": {
    "text": "Email to support",
    "to": "support@authenticateit.com",
    "subject": "I have a question"
  }
}

Phone

It shows a link to call a phone number.

Option Description
text A text that will be shown
to A phone number
{
  "phone": {
    "text": "We are waiting your call",
    "to": "+61123456789"
  }
}

Rating

It shows a current product's rating and allows provide your rating

Option Description
max Maximum value of a rating (integer)
rating Current rating (number ⇐ max)
participants Number of participants in the product's rating (integer)
enable true/false, can you give your rating
success_msg The message will appear after user's assessment
sorry_msq The message will appear after server refused user's assessment
{
  "rating": {
    "max": 5,
    "rating": "4.5",
    "participants": 2,
    "enable": true,
    "success_msg": "Thank you for your opinion!",
    "sorry_msg": "Sorry, we can't accept your assessment :( "
  }
}

Rating section

Add image

A widget for uploading an image

Option Description
message A message that shows on the widget. It explains what an image is required
{
  "add_image": {
    "message": "Add a nice photo of this product"
  }
}

Add image section

Field

A form's field

Option Description
label A field's label
type A field's type: text, number, colour, date, long_text
{
  "field": {
    "label": "Product Name",
    "type": "text"
  }
}

Field section

GDTI

Link to existing GDTI document.

Option Description
gdti Document identifier
inline Boolean value. Equivalent to false if missing.
{
  "gdti": {
    "gdti": "urn:epc:id:gdti:9212345.00001.008113943527211",
    "inline": true
  }
}

results matching ""

    No results matching ""