Skip to content

Planogram Compliance API

Send a POST request to https://api.cloud.nodeflux.io/v1/analytics/clientname-planogram-compliance by providing these arguments as application/json.

Make sure you already have configure your Authentication.

Note for endpoint

  • The clientname obtained from client name that has been registered.

Request Body

{
    "additional_params":{
        "template": []
    },
    "images": [
        "{INSERT_JPEG_IMAGE_AS_BASE64_STRING_FOR_YOUR_KTP}"
    ]
}
Key Type Description
template array Additional parameter to manually select the template you choose.
images array Your .JPG or .JPEG image in base64 using data URI scheme.

Note for image

Example request:

{
    "additional_params":{
        "template": [[1, 2, 4], [3,4,5]]
    },
    "images": [
        "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/
        2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhY
        aHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/"
    ]
}

Response Body

HTTP Mapping: 202 Accepted

{
    "job": {
        "id": "a-very-long-job-id",
        "result": {
            "status": "success",
            "analytic_type": "CLIENTNAME_PLANOGRAM_COMPLIANCE",
            "sku_detection":[
                {
                    "label": "4",
                    "confidence": 0.99992025,
                    "bounding_box": {
                        "top": 11,
                        "left": 466,
                        "height": 80,
                        "width": 47
                    }
                },
                {
                    "label": "10",
                    "confidence": 0.9997944,
                    "bounding_box": {
                        "top": 11,
                        "left": 424,
                        "height": 80,
                        "width": 46
                    }
                }
            ],
            "planogram_compliance_score": 0.8181818
        }
    },
    "message": "Job successfully submitted!",
    "ok": true
}