GLAIR Vision

https://docs.glair.ai/vision
Admin
API and SDK for integrating electronic Know Your Customer (eKYC), Retail Execution, and Paperless...
Tokens:102,463
Snippets:735
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Go SDK

Source: https://docs.glair.ai/vision/sdks

Use 'go get' to install the Go SDK. Alternatively, import modules directly for automatic dependency resolution.

```bash
go get -u github.com/glair-ai/glair-vision-go
```

--------------------------------

### NodeJS Example

Source: https://docs.glair.ai/vision/authentication

Example of how to authenticate a request using NodeJS with both Basic Authorization and an API Key.

```APIDOC
## NodeJS Authentication Example

### Description
This example demonstrates how to authenticate API requests using NodeJS by providing both Basic Authentication credentials and an API Key in the request headers.

### Method
POST

### Endpoint
/ocr/v1/ktp

### Headers
- `Authorization`: `Basic <base64-encoded username:password>`
- `x-api-key`: `<your-api-key>`

### Request Example
```javascript
const basicAuth = 'Basic ' + Buffer.from('USERNAME' + ':' + 'PASSWORD').toString('base64');
const apiKey = 'API_KEY';

fetch('/ocr/v1/ktp', {
  method: 'POST',
  headers: {
    Authorization: basicAuth,
    'x-api-key': apiKey,
  },
  // ... other request options
});
```
```

--------------------------------

### Showcase API Response Example

Source: https://docs.glair.ai/vision/retail/sync/showcase

This is an example of a successful response when retrieving all showcases. It includes showcase IDs, names, and associated 'must-have' SKUs, with some showcases also detailing a planogram.

```json
{
  "status": "SUCCESS",
  "reason": "Showing all showcase",
  "data": [
    {
      "id": "1",
      "name": "Instant Noodle Cup Rack 1",
      "planogram": null,
      "must_have_sku": [
        {
          "class_id": 333,
          "label": "Mie Sedaap Cup Baso Spesial"
        },
        {
          "class_id": 334,
          "label": "Mie Sedaap Cup Goreng"
        },
        {
          "class_id": 335,
          "label": "Mie Sedaap Cup Kari Spesial"
        },
        {
          "class_id": 336,
          "label": "Mie Sedaap Cup Korean"
        }
      ]
    },
    {
      "id": "2",
      "name": "Instant Noodle Cup Rack 2",
      "planogram": {
        "id": "3",
        "name": "Planogram Mie Sedaap",
        "products": [
          {
            "row": 4,
            "column": 0,
            "sku": {
              "class_id": 339,
              "label": "Mie Sedaap Instant"
            }
          },
          {
            "row": 3,
            "column": 0,
            "sku": {
              "class_id": 336,
              "label": "Mie Sedaap Cup Korean"
            }
          },
          {
            "row": 2,
            "column": 0,
            "sku": {
              "class_id": 337,
              "label": "Mie Sedaap Cup Rawit Bingit"
            }
          },
          {
            "row": 1,
            "column": 0,
            "sku": {
              "class_id": 335,
              "label": "Mie Sedaap Cup Kari Spesial"
            }
          },
          {
            "row": 0,
            "column": 0,
            "sku": {
              "class_id": 333,
              "label": "Mie Sedaap Cup Baso Spesial"
            }
          }
        ]
      },
      "must_have_sku": [
        {
          "class_id": 333,
          "label": "Mie Sedaap Cup Baso Spesial"
        },
        {
          "class_id": 335,
          "label": "Mie Sedaap Cup Kari Spesial"
        },
        {
          "class_id": 337,
          "label": "Mie Sedaap Cup Rawit Bingit"
        }
      ]
    }
  ]
}
```

--------------------------------

### Install NodeJS SDK

Source: https://docs.glair.ai/vision/sdks

Install the GLAIR Vision SDK for Node.js using npm. Requires Node.js v18 or higher.

```bash
npm install @glair/vision
```

--------------------------------

### cURL Example

Source: https://docs.glair.ai/vision/authentication

Example of how to authenticate a request using cURL with both Basic Authorization and an API Key.

```APIDOC
## cURL Authentication Example

### Description
This example demonstrates how to authenticate API requests using cURL by providing both Basic Authentication credentials and an API Key in the request headers.

### Method
POST

### Endpoint
/ocr/v1/ktp

### Headers
- `Authorization`: `Basic <base64-encoded username:password>`
- `x-api-key`: `<your-api-key>`

### Request Example
```bash
curl -X POST https://your-glair-api-domain.com/ocr/v1/ktp \
     -H "Authorization: Basic $(echo -n 'USERNAME:PASSWORD' | base64)" \
     -H "x-api-key: API_KEY"
```
```

--------------------------------

### Create Showcase using Node.js

Source: https://docs.glair.ai/vision/retail/sync/showcase

Use this snippet to create a new showcase. Ensure Node.js v18+ is installed. Replace 'USERNAME', 'PASSWORD', and 'API_KEY' with your credentials.

```javascript
// Minimum Node 18. Save the code as 'index.mjs' and run it by executing 'node index.mjs'
import { readFileSync } from 'fs';

const url = 'https://api.vision.glair.ai/retail/v1/data/showcase';
const basicAuth = 'Basic ' + Buffer.from('USERNAME' + ':' + 'PASSWORD').toString('base64');
const apiKey = API_KEY;

const requestBody = {
  id: '3',
  name: 'Instant Noodle Cup Rack 3',
  planogram_id: '2',
  must_have_sku: ['333']
};

const config = {
  method: 'POST',
  headers: {
    Authorization: basicAuth,
    'x-api-key': apiKey,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(requestBody)
};

const response = await fetch(url, config);
console.log(await response.json());

```

--------------------------------

### Android SDK Integration

Source: https://docs.glair.ai/vision/sdks

Example of how to integrate and configure the LivenessFragment in an Android application.

```APIDOC
## Android SDK Integration

This section details the integration of the GLAIR Vision SDK within an Android application, focusing on the `LivenessFragment` and its configuration.

### `LivenessFragment` Usage

The `LivenessFragment` can be instantiated with a `VisionConfiguration` object and a callback for handling results.

```kotlin
val customization = LivenessCustomization.Builder()
  .backgroundColor("#222222")
  .livenessCountdown(5)
  .build()

val config = VisionConfiguration.builder<LivenessCustomization>()
  .apiKey("apiKey")
  .username("username")
  .password("password")
  .customization(customization)
  .build()

fragment = LivenessFragment(config) { result ->
  Log.i("Main App", "Main app here: $result")
}

val transaction = supportFragmentManager.beginTransaction()
transaction.replace(R.id.fragment_container, fragment, LivenessFragment.TAG)
transaction.commit()
```

### `LivenessCustomization` Options

| Option | Default | Type | Description |
|---|---|---|---|
| `backgroundColor` | `#1C1B1F` | String | Background Color |
| `fontColor` | `#E6E1E5` | String | Foreground Color |
| `fontSize` | `1f` | Float | Relative Multiplier for Font Size Based on Current Size |
| `backColor` | `#E6E1E5` | String | Button Back Color |
| `livenessNumberGesture` | `1` | Int | Number of Gestures Needed |
| `progressBarColor` | `#E6E1E5` | String | Progress Bar Color |
| `gestureIllustrationColor` | `#E6E1E5` | String | Gesture Illustration Color Below Camera View |
| `livenessCountdown` | `5` | Int | Total Countdown Time |
```

--------------------------------

### Install GLAIR Vision NodeJS SDK

Source: https://docs.glair.ai/vision/quickstart

Install the GLAIR Vision NodeJS SDK using npm. Requires Node.js v18 or higher.

```bash
npm install --save @glair/vision
```

--------------------------------

### Get All Showcase - Node.js

Source: https://docs.glair.ai/vision/retail/sync/showcase

Use this code to fetch a list of all available showcases from the GLAIR Vision API. Ensure you have Node.js 18 or later installed and replace 'USERNAME', 'PASSWORD', and 'API_KEY' with your actual credentials.

```javascript
// Minimum Node 18. Save the code as 'index.mjs' and run it by executing 'node index.mjs'
import { readFileSync } from 'fs';

const url = 'https://api.vision.glair.ai/retail/v1/data/showcase';
const basicAuth = 'Basic ' + Buffer.from('USERNAME' + ':' + 'PASSWORD').toString('base64');
const apiKey = API_KEY;

const config = {
  method: 'GET',
  headers: {
    Authorization: basicAuth,
    'x-api-key': apiKey,
  }
};

const response = await fetch(url, config);
console.log(await response.json());

```

--------------------------------

### Make First API Request with cURL

Source: https://docs.glair.ai/vision/quickstart

Make a POST request to the KTP OCR endpoint without using an SDK. This requires manual setup of authentication headers and form data. Ensure you have the necessary dependencies installed ('npm install --save node-fetch form-data-encoder formdata-node'). Save the code as 'index.mjs' and run it using 'node index.mjs'.

```javascript
// Install the required dependencies: 'npm install --save node-fetch form-data-encoder formdata-node'
// Save the code as 'index.mjs' and run it by executing 'node index.mjs'
import fetch from 'node-fetch';
import { FormDataEncoder } from 'form-data-encoder';
import { FormData, Blob } from 'formdata-node';
import { fileFromPath } from 'formdata-node/file-from-path';

const url = 'https://api.vision.glair.ai/ocr/v1/ktp';
const basicAuth = 'Basic ' + btoa('USERNAME' + ':' + 'PASSWORD');
const apiKey = 'API_KEY';

const data = new FormData();
data.append('image', await fileFromPath('/path/to/image/KTP.jpeg'));
const encoder = new FormDataEncoder(data);

const config = {
  method: 'POST',
  headers: {
    Authorization: basicAuth,
    'x-api-key': apiKey,
  },
  body: new Blob(encoder, { type: encoder.contentType }),
};

const response = await fetch(url, config);
console.log(await response.json());
```

--------------------------------

### Install GLAIR Vision NodeJS SDK

Source: https://docs.glair.ai/vision/quickstart

Install the GLAIR Vision NodeJS SDK using npm. Requires Node.js v18 or higher.

```APIDOC
## Install GLAIR Vision NodeJS SDK

Requires Node.js v18 or higher.

```bash
npm install --save @glair/vision
```
```

--------------------------------

### Get All SKU Data (Node.js)

Source: https://docs.glair.ai/vision/retail/sync/sku

Use this endpoint to retrieve a list of all available SKUs. Ensure you have Node.js 18 or later installed and replace API_KEY with your actual API key.

```javascript
// Minimum Node 18. Save the code as 'index.mjs' and run it by executing 'node index.mjs'
import { readFileSync } from 'fs';

const url = 'https://api.vision.glair.ai/retail/v1/data/sku';
const apiKey = API_KEY;

const config = {
  method: 'GET',
  headers: {
    Authorization: basicAuth,
    'x-api-key': apiKey,
  }
};

const response = await fetch(url, config);
console.log(await response.json());

```

--------------------------------

### Fetch Showcase by ID using Node.js

Source: https://docs.glair.ai/vision/retail/sync/showcase

Demonstrates how to fetch a specific showcase by its ID using Node.js. Ensure you have Node 18 or higher installed and replace 'USERNAME', 'PASSWORD', and 'API_KEY' with your actual credentials.

```javascript
// Minimum Node 18. Save the code as 'index.mjs' and run it by executing 'node index.mjs'
import { readFileSync } from 'fs';

const url = 'https://api.vision.glair.ai/retail/v1/data/showcase/1';
const basicAuth = 'Basic ' + Buffer.from('USERNAME' + ':' + 'PASSWORD').toString('base64');
const apiKey = API_KEY;

const config = {
  method: 'GET',
  headers: {
    Authorization: basicAuth,
    'x-api-key': apiKey,
  }
};

const response = await fetch(url, config);
console.log(await response.json());

```

--------------------------------

### Create SKU (Node.js)

Source: https://docs.glair.ai/vision/retail/sync/sku

Create a new SKU with required 'id' and 'label', and optional 'color'. This example uses Node.js 18+ and requires authentication.

```javascript
// Minimum Node 18. Save the code as 'index.mjs' and run it by executing 'node index.mjs'
import { readFileSync } from 'fs';

const url = 'https://api.vision.glair.ai/retail/v1/data/sku';
const basicAuth = 'Basic ' + Buffer.from('USERNAME' + ':' + 'PASSWORD').toString('base64');
const apiKey = API_KEY;

const requestBody = {
  id: 337,
  label: "Mie Sedaap Cup Korean",
  color: "#FF0000"
};

const config = {
  method: 'POST',
  headers: {
    Authorization: basicAuth,
    'x-api-key': apiKey,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(requestBody)
};

const response = await fetch(url, config);
console.log(await response.json());

```

--------------------------------

### OCR KTP with Go SDK

Source: https://docs.glair.ai/vision/sdks

Example of performing KTP OCR using the Go SDK. Ensure the image file path is correct and handle potential errors.

```go
package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"

	"github.com/glair-ai/glair-vision-go"
	"github.com/glair-ai/glair-vision-go/client"
)

func main() {
	ctx := context.Background()

	config := glair.NewConfig("", "", "")
	client := client.New(config)

	file, _ := os.Open("path/to/image.jpg")

	result, err := client.Ocr.KTP(ctx, glair.OCRInput{
		Image: file,
	})

	if err != nil {
		log.Fatalln(err.Error())
	}

	jsonResponse, _ := json.MarshalIndent(result, "", "  ")

	fmt.Println(string(jsonResponse))
}
```

--------------------------------

### Get All SKU

Source: https://docs.glair.ai/vision/retail/sync/sku

Retrieves a list of all available SKUs in the system. This endpoint is currently in beta.

```APIDOC
## GET /retail/v1/data/sku

### Description
Get list of available SKU.

### Method
GET

### Endpoint
/retail/v1/data/sku

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **reason** (string) - Provides a message about the result of the operation.
- **data** (array) - An array of SKU objects.
  - **id** (integer) - The unique identifier for the SKU.
  - **label** (string) - The name or label of the SKU.
  - **color** (string) - The color associated with the SKU.

### Response Example
```json
{
  "status": "SUCCESS",
  "reason": "Showing all SKU",
  "data": [
    {
      "id": 333,
      "label": "Mie Sedaap Cup Baso Spesial",
      "color": "#FF0000"
    },
    {
      "id": 334,
      "label": "Mie Sedaap Cup Goreng",
      "color": "#FF0000"
    },
    {
      "id": 335,
      "label": "Mie Sedaap Cup Kari Spesial",
      "color": "#FF0000"
    },
    {
      "id": 336,
      "label": "Mie Sedaap Cup Korean",
      "color": "#FF0000"
    }
  ]
}
```
```

--------------------------------

### Initialize Java SDK

Source: https://docs.glair.ai/vision/sdks

Configure and initialize the GLAIR Vision SDK in Java using VisionSettings. This example demonstrates setting credentials and performing an OCR operation on an image.

```java
import glair.vision.Vision;
import glair.vision.model.VisionSettings;

public class App {
  public static void main(String[] args) {
    VisionSettings settings = new VisionSettings.Builder()
      .username("username")
      .password("password")
      .apiKey("api-key")
      .build();

    Vision vision = new Vision(settings);

    String imagePath = "/path/to/image.jpg";
    String response = "";

    try {
      KtpParam param = new KtpParam(imagePath);
      response = vision
        .ocr()
        .ktp(param);
    } catch (Exception e) {
      response = e.getMessage();
    }

    System.out.println("Response: " + response);
  }
}
```

--------------------------------

### Get All Showcase

Source: https://docs.glair.ai/vision/retail/sync/showcase

Retrieves a list of all available showcases. This endpoint is currently in beta and requires direct contact for access.

```APIDOC
## GET /retail/v1/data/showcase

### Description
Get list of available showcase.

### Method
GET

### Endpoint
/retail/v1/data/showcase

### Request Example
```javascript
// Minimum Node 18. Save the code as 'index.mjs' and run it by executing 'node index.mjs'
import { readFileSync } from 'fs';

const url = 'https://api.vision.glair.ai/retail/v1/data/showcase';
const basicAuth = 'Basic ' + Buffer.from('USERNAME' + ':' + 'PASSWORD').toString('base64');
const apiKey = API_KEY;

const config = {
  method: 'GET',
  headers: {
    Authorization: basicAuth,
    'x-api-key': apiKey,
  }
};

const response = await fetch(url, config);
console.log(await response.json());
```

### Response
#### Success Response (200)
- **id** (string) - String representing showcase id.
- **name** (string) - String representing showcase name.
- **planogram** (object | null) - Object container for holding the corresponding planogram to this showcase.
  - **id** (string) - The ID of the planogram.
  - **name** (string) - String specifying the given name of the planogram.
  - **products** (array of Placement) - Array of object container for holding the corresponding placements to this planogram.
- **must_have_sku** (array of SKU) - Array of object container for holding the corresponding must have SKU to this showcase.
  - **class_id** (string) - The class ID of the SKU.
  - **label** (string) - String specifying the given name of the SKU.

#### Response Example
{
  "id": "showcase_id_123",
  "name": "Summer Collection Showcase",
  "planogram": {
    "id": "planogram_abc",
    "name": "Main Floor Planogram",
    "products": [
      {
        "row": 1,
        "column": "A",
        "sku": {
          "class_id": "sku_class_001",
          "label": "T-Shirt Red"
        }
      }
    ]
  },
  "must_have_sku": [
    {
      "class_id": "sku_class_002",
      "label": "Jeans Blue"
    }
  ]
}
```

--------------------------------

### Make First API Request (cURL)

Source: https://docs.glair.ai/vision/quickstart

Example of calling the KTP endpoint directly using cURL without the SDK. Includes authentication details.

```APIDOC
## Making request without SDK (cURL)

### Description
This example shows how to make a POST request to the KTP OCR endpoint using cURL, including authentication headers and form data for the image.

### Method
POST

### Endpoint
`/ocr/v1/ktp`

### Headers
- `Authorization`: Basic authentication header (Base64 encoded username:password).
- `x-api-key`: Your API key.

### Request Body
- `image`: The image file to be processed.

### Request Example
```bash
# Install the required dependencies: 'npm install --save node-fetch form-data-encoder formdata-node'
# Save the code as 'index.mjs' and run it by executing 'node index.mjs'
import fetch from 'node-fetch';
import { FormDataEncoder } from 'form-data-encoder';
import { FormData, Blob } from 'formdata-node';
import { fileFromPath } from 'formdata-node/file-from-path';

const url = 'https://api.vision.glair.ai/ocr/v1/ktp';
const basicAuth = 'Basic ' + btoa('USERNAME' + ':' + 'PASSWORD');
const apiKey = 'API_KEY';

const data = new FormData();
data.append('image', await fileFromPath('/path/to/image/KTP.jpeg'));
const encoder = new FormDataEncoder(data);

const config = {
  method: 'POST',
  headers: {
    Authorization: basicAuth,
    'x-api-key': apiKey,
  },
  body: new Blob(encoder, { type: encoder.contentType }),
};

const response = await fetch(url, config);
console.log(await response.json());
```
```

--------------------------------

### Make First API Request (NodeJS SDK)

Source: https://docs.glair.ai/vision/quickstart

Example of calling the KTP endpoint using the GLAIR Vision NodeJS SDK. Supports various image input types.

```APIDOC
## Making your first API request with NodeJS SDK

### Description
This example demonstrates how to initialize the Vision SDK and call the `ktp` OCR endpoint with an image file.

### Method
`vision.ocr.ktp({ image: '/path/to/image/KTP.jpg' })`

### Parameters
#### Request Body
- **image** (string) - Required - Path to the image file (e.g., KTP.jpg).

### Request Example
```javascript
import { Vision } from '@glair/vision';

const vision = new Vision({
  apiKey: 'api-key',
  username: 'username',
  password: 'password',
});

// The SDK supports various image input types: file path, base64, or Blob/File
await vision.ocr.ktp({ image: '/path/to/image/KTP.jpg' });
```
```

--------------------------------

### Showcase API Success Response

Source: https://docs.glair.ai/vision/retail/sync/showcase

This is an example of a successful response when retrieving all showcases. The response includes status and reason, with additional showcase data omitted for brevity.

```json
{
  "status": "SUCCESS",
  "reason": "Showing all showcase",
  //...,
}
```

--------------------------------

### Create NPWP Session and Redirect

Source: https://docs.glair.ai/vision/prebuilt

Start an NPWP (Indonesian Tax ID card) verification session. Configure success and cancel URLs for user redirection. Users are then sent to the generated session URL to complete the verification.

```javascript
// server.js
import express from 'express';
import { Vision } from '@glair/vision';

const app = express();
const vision = new Vision({
  apiKey: 'api-key',
  username: 'username',
  password: 'password',
});

const YOUR_DOMAIN = 'http://localhost:3000';

app.post('/npwp-session', async (req, res) => {
  const session = await vision.ocr.npwpSessions.create({
    success_url: `${YOUR_DOMAIN}?success=true`,
    cancel_url: `${YOUR_DOMAIN}?canceled=true`
  });

  res.redirect(303, session.url);
});

app.get('/npwp-result', async (req, res) => {
  const sid = req.query.sid
  const result = await vision.ocr.npwpSessions.retrieve({sid})
  res.json(result)
});

app.listen(3000, () => console.log('Running on port 3000'));

```

--------------------------------

### Analyze Showcase Visibility with Node.js

Source: https://docs.glair.ai/vision/retail/showcase

Use this Node.js snippet to send an image to the /showcase endpoint for visibility analysis. Ensure you have Node 18 or later installed and replace placeholders with your credentials and image path.

```javascript
// Minimum Node 18. Save the code as 'index.mjs' and run it by executing 'node index.mjs'
import { readFileSync } from 'fs';

const url = 'https://api.vision.glair.ai/showcase';
const basicAuth = 'Basic ' + Buffer.from('USERNAME' + ':' + 'PASSWORD').toString('base64');
const apiKey = API_KEY;

const data = new FormData();
data.append('image', new Blob(
  [readFileSync('/path/to/image/showcase.jpg')],
  { type: 'image/jpg' }
));

const config = {
  method: 'POST',
  headers: {
    Authorization: basicAuth,
    'x-api-key': apiKey,
  },
  body: data,
};

const response = await fetch(url, config);
console.log(await response.json());

```

--------------------------------

### Showcase by ID API Response Example

Source: https://docs.glair.ai/vision/retail/sync/showcase

This JSON structure represents the response when a specific showcase is retrieved by its ID. It includes detailed information about the showcase, its planogram if available, and its 'must-have' SKUs.

```json
{
  "status": "SUCCESS",
  "reason": "Showing showcase by identifier: 1",
  "data": {
    "id": "1",
    "name": "Instant Noodle Cup Rack 1",
    "planogram": null,
    "must_have_sku": [
      {
        "class_id": 333,
        "label": "Mie Sedaap Cup Baso Spesial"
      },
      {
        "class_id": 334,
        "label": "Mie Sedaap Cup Goreng"
      },
      {
        "class_id": 335,
        "label": "Mie Sedaap Cup Kari Spesial"
      },
      {
        "class_id": 336,
        "label": "Mie Sedaap Cup Korean"
      }
    ]
  }
}
```

--------------------------------

### Create Showcase

Source: https://docs.glair.ai/vision/retail/sync/showcase

Creates a new showcase with the provided details. Requires authentication and an API key.

```APIDOC
## POST /retail/v1/data/showcase

### Description
Creates a new showcase.

### Method
POST

### Endpoint
/retail/v1/data/showcase

### Request Body
- **id** (string) - Required - The unique identifier for the showcase.
- **name** (string) - Required - The name of the showcase.
- **planogram_id** (string) - Required - The ID of the associated planogram.
- **must_have_sku** (array of string) - Required - An array of SKU IDs that are essential for this showcase.

### Request Example
```json
{
  "id": "3",
  "name": "Instant Noodle Cup Rack 3",
  "planogram_id": "2",
  "must_have_sku": ["333"]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation (e.g., "SUCCESS").
- **reason** (string) - Provides a message about the outcome of the operation.

#### Response Example
```json
{
  "status": "SUCCESS",
  "reason": "Showcase successfully created"
}
```
```

--------------------------------

### Initialize Vision Client (Node.js)

Source: https://docs.glair.ai/vision/npwp

Initialize the Vision client with your API credentials. Ensure you have the correct API key, username, and password.

```javascript
import ApiClient from '@glair/vision';

const vision = new Vision({ apiKey: 'api-key', username: 'username', password: 'password' });
```

--------------------------------

### Create Showcase

Source: https://docs.glair.ai/vision/retail/sync/showcase

Creates a new showcase with the provided details.

```APIDOC
## POST /retail/v1/data/showcase

### Description
Create showcase.

### Method
POST

### Endpoint
/retail/v1/data/showcase

### Parameters
#### Request Body
- **id** (string) - Required - String representing showcase id.
- **name** (string) - Required - String representing showcase name.
- **planogram_id** (string) - Optional - String representing If of the planogram.
- **must_have_sku** (array of string) - Optional - Array of sku id container for holding the corresponding must have SKU to this showcase.

### Request Example
```json
{
  "id": "example_id",
  "name": "example_name",
  "planogram_id": "optional_planogram_id",
  "must_have_sku": ["sku1", "sku2"]
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.
- **reason** (string) - A message indicating the reason for the response.
- **data** (object) - Contains the details of the created showcase.
  - **id** (string) - The unique identifier of the showcase.
  - **name** (string) - The name of the showcase.
  - **planogram_id** (string) - The ID of the associated planogram.
  - **must_have_sku** (array) - A list of SKUs required for this showcase.

#### Response Example
```json
{
  "status": "SUCCESS",
  "reason": "Showcase created successfully",
  "data": {
    "id": "example_id",
    "name": "example_name",
    "planogram_id": "optional_planogram_id",
    "must_have_sku": [
      "sku1",
      "sku2"
    ]
  }
}
```
```

--------------------------------

### Sample Response: OK (Readable KTP)

Source: https://docs.glair.ai/vision/ktp

This is a successful response when the KTP image is readable and processed correctly.

```json
{
    "status": "SUCCESS",
    "reason": "File Successfully Read",
    "qualities": {
        "is_blurred": false,
        "is_bright": false,
        "is_copy": false,
        "is_cropped": false,
        "is_dark": false,
        "is_flash": false,
        "is_ktp": true,
        "is_rotated": false,
        "is_taken_from_screen": false
    },
    "images": {
        "photo": "/9j/4AAQSkZJRgABAQAAAQABAAD/",
        "sign": "/9j/4AAQSkZJRgABAQAAAQABAAD/"
    },
    "read": {
      // KTP fields
    }
}

```

--------------------------------

### Utilizing View Controllers (iOS)

Source: https://docs.glair.ai/vision/sdks

How to use the pre-built KTP and Liveness View Controllers provided by the VisionApp SDK.

```APIDOC
## Utilizing View Controllers (iOS)

This section explains how to use the provided `KTP View Controller` and `Liveness View Controller` for a streamlined UI experience.

### Setting Callbacks

Configure a callback for when the app should close.

```swift
VisionApp.sharedInstance.setCloseAppCallback {
    presentationMode.wrappedValue.dismiss()
}
```

### Using KTP View Controller

Instantiate and present the KTP View Controller to capture and read KTP data.

```swift
let viewController = VisionApp.sharedInstance.ktpView({
    result in
    // Get result properties: ktp result, captured image, and error
})
```

### Using Liveness View Controller

Instantiate and present the Liveness View Controller for liveness detection.

```swift
let viewController = VisionApp.sharedInstance.livenessView({
    result in
    // Get result properties: success and response histories
})
```
```

--------------------------------

### Get Showcase by Id

Source: https://docs.glair.ai/vision/retail/sync/showcase

Retrieves a specific showcase by its unique identifier.

```APIDOC
## GET /retail/v1/data/showcase/{id}

### Description
Get showcase by identifier.

### Method
GET

### Endpoint
/retail/v1/data/showcase/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the showcase.

### Request Example
```
GET /retail/v1/data/showcase/1
```

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.
- **reason** (string) - A message indicating the reason for the response.
- **data** (object) - Contains the showcase details.
  - **id** (string) - The unique identifier of the showcase.
  - **name** (string) - The name of the showcase.
  - **planogram** (object or null) - The planogram associated with the showcase, or null if none.
  - **must_have_sku** (array) - A list of SKUs that are required for this showcase.
    - **class_id** (integer) - The class ID of the SKU.
    - **label** (string) - The label or name of the SKU.

#### Response Example
```json
{
  "status": "SUCCESS",
  "reason": "Showing showcase by identifier: 1",
  "data": {
    "id": "1",
    "name": "Instant Noodle Cup Rack 1",
    "planogram": null,
    "must_have_sku": [
      {
        "class_id": 333,
        "label": "Mie Sedaap Cup Baso Spesial"
      },
      {
        "class_id": 334,
        "label": "Mie Sedaap Cup Goreng"
      },
      {
        "class_id": 335,
        "label": "Mie Sedaap Cup Kari Spesial"
      },
      {
        "class_id": 336,
        "label": "Mie Sedaap Cup Korean"
      }
    ]
  }
}
```
```

--------------------------------

### Launch KTP Activity with Customization

Source: https://docs.glair.ai/vision/sdks

Launches the KTP verification activity using `registerForActivityResult`. Customize the SDK's appearance by providing a `KtpCustomization` object.

```kotlin
class MainActivity: AppCompatActivity() {
  private var activityResultLauncher =
    registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
      processResult(result)
    }

  private fun initializeSdk() {
    val customization = KtpCustomization.Builder() 
      .backgroundColor("#222222")
      .captureButtonColor("#ff0000")
      .build()

    val config = VisionConfiguration.builder<KtpCustomization>()
      .apiKey(apiKey)
      .username(username)
      .password(password)
      .customization(customization)
      .build()

    val intent = Intent(this@MainActivity, KtpActivity::class.java).apply {
      putExtra(KtpActivity.CONFIGURATION, config)
    }

    activityResultLauncher.launch(intent)
  }

  private fun processResult(result: ActivityResult) {
    if (result.resultCode == KtpActivity.RESULT_CODE && result.data != null) {
      val resultData = result.data!!.getStringExtra(KtpActivity.RESULT_KEY)

      Log.i("Main App", "Main app here: $resultData")
    }
  }
}
```

--------------------------------

### Get SKU by Id

Source: https://docs.glair.ai/vision/retail/sync/sku

Retrieves a specific SKU by its unique identifier. This endpoint is currently in beta.

```APIDOC
## GET /retail/v1/data/sku/{id}

### Description
Get SKU by identifier.

### Method
GET

### Endpoint
/retail/v1/data/sku/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the SKU to retrieve.

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **reason** (string) - Provides a message about the result of the operation.
- **data** (object) - The SKU object.
  - **id** (integer) - The unique identifier for the SKU.
  - **label** (string) - The name or label of the SKU.
  - **color** (string) - The color associated with the SKU.

### Response Example
```json
{
  "status": "SUCCESS",
  "reason": "Showing SKU by identifier: 336",
  "data": {
    "id": 336,
    "label": "Mie Sedaap Cup Korean",
    "color": "#FF0000"
  }
}
```
```

--------------------------------

### Document Classification Output

Source: https://docs.glair.ai/vision/qualities

Example JSON output for document classification, showing the detected document type and its confidence score.

```json
{
  "document": {
    "confidence": 0.9999924898147583,
    "value": "ktp"
  }
}
```

--------------------------------

### Install Java SDK

Source: https://docs.glair.ai/vision/sdks

Add the GLAIR Vision SDK dependency to your Gradle project. Requires Java 8 or higher.

```gradle
implementation 'ai.glair:glair-vision:0.0.1-beta.1'
```

--------------------------------

### Make First API Request with NodeJS SDK

Source: https://docs.glair.ai/vision/quickstart

Initialize the Vision SDK with your credentials and make a call to the KTP OCR endpoint. The SDK supports image input via file path, base64, or Blob/File.

```javascript
import { Vision } from '@glair/vision';

const vision = new Vision({
  apiKey: 'api-key',
  username: 'username',
  password: 'password',
});

// The SDK supports various image input types: file path, base64, or Blob/File
await vision.ocr.ktp({ image: '/path/to/image/KTP.jpg' });
```

--------------------------------

### SKU Sync Response Example

Source: https://docs.glair.ai/vision/retail/sync/sku

This JSON structure represents a failed response during SKU synchronization, indicating an internal server error.

```json
{
  "status": "FAILED",
  "reason": "Internal server error"
}
```

--------------------------------

### Sample Response: OK (Non-KTP File)

Source: https://docs.glair.ai/vision/ktp

This response indicates that the file was read successfully, but it was not identified as a KTP, or some fields are invalid.

```json
{
  "status": "SUCCESS",
  "reason": "File successfully read. Some fields are invalid.",
  //...,
}

```

--------------------------------

### Showcase API Internal Server Error Response

Source: https://docs.glair.ai/vision/retail/sync/showcase

This is an example of an internal server error response, indicating a failure on the server side.

```json
{
  "status": "FAILED",
  "reason": "Internal server error",
}
```

--------------------------------

### Showcase API Bad Request Response

Source: https://docs.glair.ai/vision/retail/sync/showcase

This is an example of a bad request response, typically indicating that the specified showcase ID does not exist.

```json
{
  "status": "FAILED",
  "reason": "Showcase id does not exist",
}
```

--------------------------------

### Initialize Vision SDK and Read License Plate (Node.js)

Source: https://docs.glair.ai/vision/plate

Initializes the Vision SDK with API credentials and demonstrates how to call the license plate OCR method. Ensure you have the correct API key, username, and password.

```javascript
import { Vision } from '@glair/vision';

const vision = new Vision({ apiKey: 'api-key', username: 'username', password: 'password' });

await vision.ocr.licensePlate({ image: '/path/to/image/Plate.jpg' });
```

--------------------------------

### Screen/Spoofing Detection Output

Source: https://docs.glair.ai/vision/qualities

Example JSON output indicating whether a document is a screen capture or spoofed, along with confidence scores.

```json
{
  "screen": {
    "confidence": 0.9999924898147583,
    "confidence_screen": 0.9999924898147583,
    "value": true
  }
}
```

--------------------------------

### POSM Analysis Success Response

Source: https://docs.glair.ai/vision/retail/posm

Example of a successful response from the POSM analysis endpoint, detailing the status, detected objects, and their properties.

```json
{
  "status": "SUCCESS",
  "reason": "File successfully read",
  "posm_score": 100,
  "detected_object": [
    {
      "class_id": 5,
      "coordinate": {
        "xmin": 6,
        "ymin": 911,
        "xmax": 268,
        "ymax": 1164
      },
      "label": "wakuwaku-tebak-rasa",
      "confidence": 0.9975013136863708
    },
    {
      "class_id": 0,
      "coordinate": {
        "xmin": 1388,
        "ymin": 927,
        "xmax": 1628,
        "ymax": 1163
      },
      "label": "frostbite-chocolate-strawberry",
      "confidence": 0.9959197044372559
    }
  ]

}

```

--------------------------------

### Import Go SDK Modules

Source: https://docs.glair.ai/vision/sdks

Import the necessary modules for the Go SDK. The Go toolchain will handle dependency resolution.

```go
import (
    "github.com/glair-ai/glair-vision-go"
    "github.com/glair-ai/glair-vision-go/client"
)
```

--------------------------------

### Java SDK - OCR KTP

Source: https://docs.glair.ai/vision/sdks

This snippet shows how to integrate the Java SDK to perform OCR on a KTP image. It includes configuration and usage examples.

```APIDOC
## Java SDK - OCR KTP

### Description
This example demonstrates how to configure and use the GLAIR Vision Java SDK to perform OCR on a KTP image.

### Method
`vision.ocr().ktp(param)`

### Parameters
#### `KtpParam` Constructor
- **imagePath** (String) - Required - The path to the image file.

#### `VisionSettings` Builder Options
- **apiKey** (String) - Required - Your API key.
- **username** (String) - Required - Your username.
- **password** (String) - Required - Your password.
- **baseUrl** (String) - Optional - Base URL for the API. Defaults to `https://api.vision.glair.ai`.
- **apiVersion** (String) - Optional - GLAIR Vision API version. Defaults to `v1`.

### Request Example
```java
import glair.vision.Vision;
import glair.vision.model.VisionSettings;

public class App {
  public static void main(String[] args) {
    VisionSettings settings = new VisionSettings.Builder()
      .username("username")
      .password("password")
      .apiKey("api-key")
      .build();

    Vision vision = new Vision(settings);

    String imagePath = "/path/to/image.jpg";
    String response = "";

    try {
      KtpParam param = new KtpParam(imagePath);
      response = vision.ocr().ktp(param);
    } catch (Exception e) {
      response = e.getMessage();
    }

    System.out.println("Response: " + response);
  }
}
```

### Response
#### Success Response
- **response** (String) - The OCR result.
```

--------------------------------

### Launch Liveness Activity with Customization

Source: https://docs.glair.ai/vision/sdks

Initiates the Liveness verification flow via an activity using `registerForActivityResult`. Allows customization of the liveness experience, such as background color and countdown duration.

```kotlin
class MainActivity: AppCompatActivity() {
  private var activityResultLauncher =
    registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
      processResult(result)
    }

  private fun initializeSdk() {
    val customization = LivenessCustomization.Builder()
      .backgroundColor("#222222")
      .livenessCountdown(5)
      .build()

    val config = VisionConfiguration.builder<LivenessCustomization>()
      .apiKey(apiKey)
      .username(username)
      .password(password)
      .customization(customization)
      .build()

    val intent = Intent(this@MainActivity, LivenessActivity::class.java).apply {
      putExtra(LivenessActivity.CONFIGURATION, config)
    }

    activityResultLauncher.launch(intent)
  }

  private fun processResult(result: ActivityResult) {
    if (result.resultCode == LivenessActivity.RESULT_CODE && result.data != null) {
      val resultData = result.data!!.getStringExtra(LivenessActivity.RESULT_KEY)

      Log.i("Main App", "Main app here: $resultData")
    }
  }
}
```

--------------------------------

### Initialize Vision SDK and Detect Passive Liveness (Node.js)

Source: https://docs.glair.ai/vision/passive-liveness

Initializes the Vision SDK with API credentials and calls the passiveLiveness method with an image path. Ensure you have the correct API key, username, and password.

```javascript
import { Vision } from '@glair/vision';

const vision = new Vision({ apiKey: 'api-key', username: 'username', password: 'password' });

await vision.faceBio.passiveLiveness({ image: '/path/to/image/Face.jpg' });
```

--------------------------------

### Create SKU

Source: https://docs.glair.ai/vision/retail/sync/sku

Creates a new SKU in the system. This endpoint is currently in beta.

```APIDOC
## POST /retail/v1/data/sku

### Description
Create SKU.

### Method
POST

### Endpoint
/retail/v1/data/sku

### Parameters
#### Request Body
- **id** (string) - Required - String representing SKU id.
- **label** (string) - Required - String representing SKU label.
- **color** (string) - Optional - String representing SKU color.

### Request Example
```json
{
  "id": 337,
  "label": "Mie Sedaap Cup Korean",
  "color": "#FF0000"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **reason** (string) - Provides a message about the result of the operation.

### Response Example
```json
{
  "status": "SUCCESS",
  "reason": "SKU successfully created"
}
```
```

--------------------------------

### Successful Showcase Analysis Response

Source: https://docs.glair.ai/vision/retail/showcase

This is an example of a successful response when a readable showcase image is provided. It indicates the status, reason, detection result, and confidence score.

```json
{
  "status": "SUCCESS",
  "reason": "File successfully read",
  "detected": true,
  "recognition_result": {
    "confidence": 99.99978542327881,
    "label": "visible"
  }
}

```

--------------------------------

### Share of Shelf Analysis Response (Success)

Source: https://docs.glair.ai/vision/retail/kpi/sos

Example of a successful response from the Share of Shelf analysis endpoint, detailing product scores and competitor product information.

```json
{
  "status": "SUCCESS",
  "reason": "File successfully read",
  "share_of_shelf": {
    "own_product_score": 77.78,
    "competitor_product_score": 22.22,
    "competitor_products": [
      {
        "brand": "Pop Mie",
        "score": 11.11
      },
      {
        "brand": "Gaga",
        "score": 11.11
      }
    ]
  }
}

```
Tokens:
Raw