Quick Start

Overview

To facilitate the rapid integration of Clobotics Retail AI (Artificial Intelligence) and BI (Business Insight) capabilities, we offer two complementary components: Clobotics Camera SDK and Clobotics OpenAPI system, enabling full access to our retail AI and BI functionalities.

Clobotics Camera SDK exclusively provides local capabilities:

• Capture a single image
• Capture stitched images
• Local AI mode detection abilities

Notes:

• The Camera SDK does not include any server, cloud, or Clobotics OpenAPI interaction logic. It operates in a pure offline mode and does not require network access permission.

• OpenAPI system offers Restful API style APIs, making it convenient for implementation regardless of the development language you are using.

Integration methods

The integration process between our Camera SDK and OpenAPI platform is outlined in the following charts. Although there are two integration methods to choose from, we strongly recommend opting for the method 1 due to its enhanced security features.

Method 1: Recommended

• The app integrates Camera SDK and exclusively interacts with your own cloud server.
• Your own cloud server engages in bi-directional communication with Clobotics Retail Cloud, while your app itself does not have any interaction with Clobotics Retail Cloud.

Notes:

• Your app exclusively interacts with your dedicated cloud server.
• Your app does not retain APPID and APPSECRET, enhancing system security.
• We provide an automatic notification callback mechanism, where your backend system will receive result notifications at the specified callback_url. You can refer more in Callback section.

Method 2: Optional

• The app integrates Camera SDK and interacts with both your own cloud server and Clobotics Retail Cloud.
• Both your app and your own cloud server communicate with Clobotics Retail Cloud. It's crucial to note that the APPID and APPSECRET, provided by Clobotics, are retained in your app and may be at risk of exposure in the event of a security breach.

Notes:

• Your app interacts with both your cloud server and Clobotics Retail Cloud.
• The retention of APPID and APPSECRET in your app may compromise system security.
• While we offer an automatic notification callback mechanism, it's important to note that this feature is only supported exclusively in the backend system.

Camera SDK

What Camera SDK can do?

Depending on the platform you are using, please refer to the specific documents:

• Camera SDK for Android
• Camera SDK for iOS

About multi-platform support

There are popular multi-platform tools like Flutter, etc. However, our Camera SDK offers pure native Android and iOS libraries for seamless integration. Regardless of the tool you choose, you can smoothly integrate our SDK by referring to the specified official documents.

For Android, we provide an SDK library along with a demo written in Java. Similarly, for iOS, we offer an SDK library and a demo written in Swift.

Please note that we do not provide demos for multi-platform tools like Flutter. You will need to implement the integration by referring to their respective official documents. Summarily:

• Flutter: Platform integration

Minimum requirements

To access information about the minimum hardware and software requirements, as well as the minimum system OS version, please refer to: Requirements for Clobotics Camera SDK Integration

OpenAPI Platform

Please refer to the OpenAPI section for more details.

How much time will be required for the integration?

If you are experienced in Android, iOS, and Restful HTTP API development, typically the integration process will take approximately 1 to 2 weeks.