BlockchainID QR code

BlockchainID is a simple OAuth2 to request personal and verified data from OriginalMy users.

Installation

yarn add @originalmy/blockchainid-qrcode-plugin

Or

npm install @originalmy/blockchainid-qrcode-plugin

Import

const BlockchainID = require("@originalmy/blockchainid-qrcode-plugin");

Or

import BlockchainID from "@originalmy/blockchainid-qrcode-plugin";

Or

<script src="https://unpkg.com/@originalmy/blockchainid-qrcode-plugin/dist/blockchainid.js"></script>

Usage

On JavaScript:

const blockchainID = new BlockchainID({
  companyId: YOUR_COMPANY_ID,
});

blockchainID.onAuthenticate = function (nonce) {
  console.log("Authentication OMyID", nonce);
  console.log(
    "Make a request to your backend here sending the nonce to get user infos"
  );
};

blockchainID.onExpire = function () {
  console.log("Link OMyID expired");
};

blockchainID.onCancel = function () {
  console.log("Canceling...");
};

On HTML:

<div id="blockchainID"></div>

Properties

el

Element where BlockchainID button will stay.

companyId

CompanyID given by OriginalMy API.

infos

List of informations to require from user. See the complete list in documentation.

mode

Values: dialog | body | kiosque | link (default: dialog)

QR code display type

mobileScheme

Values: originalmy (default)

Scheme defined to open the app

buttonIcon

Image URL that stay in button left side

buttonText

Button text

showQRCodeIcon

If you desire to show OriginalMy icon on QR code (default: true)

dialogLogo

Image URL that stay on dialog top

lang

Values: String en (default) | pt

Plugin language

closeButtonIconColor

Values: String #000000 (default)

Dialog close button color

buttonStyle

Override button style

buttonIconStyle

Override button icon style

buttonTextStyle

Override button text style

qrcodeStyle

Override QR code style

qrcodeContainerStyle

Override QR code container style

dialogStyle

Override dialog style

dialogBackdropStyle

Override dialog backdrop style

dialogLogoStyle

Override dialog logo style

dialogCloseButtonStyle

Override dialog close button style

translations

Texts translations

{
  "en": {
    "buttonText": "..."
  },
  "pt-BR": {
    "buttonText": "..."
  }
}

Events

onAuthenticate

Function to be called when the user scan the QR code and accept the required data.

onExpire

Function to be called when the QR code expires.

onCancel

Function to be called when user closes the dialog and cancel authentication.

onURL

Function to be called when starts Blockchain session to get login URL.

Contact

Any bug, error and doubt contato@originalmy.com

OriginalMy. All rights reserved