Skip to content

carxparts/product-authentication-client-sdk

Repository files navigation

Introduction

Product Authentication is a service offered by Carxparts which helps vendors verify products (for e.g., car parts) in their inventory.

This is how Product Authentication works:

  1. User scans a QR code on their device.
  2. The QR code opens a website, which shows if the product is authentic or not.

This open source client SDK is for vendors who are our customers and want to integrate Product Authentication into their own websites.

How to install

npm install @carxparts/product-authentication-client
or
yarn add @carxparts/product-authentication-client

Examples

CommonJS/ES6 Uses

// import { ProductAuthenticationClient } from '@carxparts/product-authentication-client';
const {
  ProductAuthentication,
} = require("@carxparts/product-authentication-client");

(async () => {
  const option = {
    userName: "", // your user name for the product authentication
    baseUrl: "", // your base url for the product authentication
  };

  const pda = new ProductAuthentication(option);
  const data = await pda.verify("3fa85f64-5717-4562-b3fc-2c963f66afa6");
  console.log(data);
})();

HTML Uses

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Document</title>
    <script src="[script-link]"></script>
  </head>
  <body>
    <h1>Test Html</h1>
  </body>
  <script>
    const option = {
      userName: "", // this is required
      baseUrl: "", // this is required
    };

    const pda = new carxparts.ProductAuthentication(option);
    pda
      .verify("3fa85f64-5717-4562-b3fc-2c963f66afa6")
      .then((response) => {
        console.log("response", response);
      })
      .catch((error) => {
        const data = error;
        if (data?.data?.errorCode === 101) {
          console.error("PRODUCT_IS_NOT_AUTHENTICATED_STATE");
        } else if (data?.data?.errorCode === 102) {
          console.error("PRODUCT_IS_AUTHENTICATED_BUT_MAX_LIMIT_REACHED_STATE");
        }
        console.error("catch error", error);
      });
  </script>
</html>

About

Product Authentication is a service offered by Carxparts which helps vendors verify products (for e.g., car parts) in their inventory.

Resources

License

Stars

Watchers

Forks

Packages

No packages published