@verityguard/emblem-sdk-client NPM

Emblem SDK Client

Client SDK for interacting with the Emblem API

Installation

npm install @verityguard/emblem-sdk-client

yarn add @verityguard/emblem-sdk-client

Usage

import React, { useRef } from 'react';
import { EmblemButton } from '@verityguard/emblem-sdk-client';

function App() {
  const closeWindowRef = useRef<() => void>();

  useEffect(() => {
    if (completed) {
      closeWindowRef.current?.();
    }
  }, [completed]);

  return (
    <div>
      <EmblemButton
        url="https://emblem.generflow.com"
        projectKey="public_key_1234"
        state="state1234"
        style={{ marginRight: "1rem", border: "1px solid gray" }}
        postbackUrl="https://example.com/postback"
        postbackHeaders={JSON.stringify({ 'x-gateway': 'abcd-1234' })}
        onSuccessUrl="https://example.com/redirect"
        onClickCallback={() => console.log("onClick callback")}
        assignCloseWindow={(closeFn) => {
          closeWindowRef.current = closeFn;
        }}
      />
    </div>
  );
}

export default App;

`EmblemButton` Props

Prop	Type	Required	Description
url	string	true	Emblem host url
projectKey	string	true	Project key is provided by Emblem
state	string	true	State is a unique identifier for the user provided by the integrator (you). This can be JSON encoded if you want to store more data with it. Emblem will pass this string along through every step
postbackUrl	string	true	URL that Emblem will send a POST request to after the user completes the age verification flow
postbackHeaders	string	false	JSON stringified object that will be url encoded within the button component. These headers will be included with the POST request
postbackOverride	boolean	false	If true, only the postback will be sent. The POST to the project key's verification url will not be sent
onSuccessUrl	string	false	If provided the user will be redirected to this url on successful verification
onClickCallback	function	false	This function will be called in addition to opening the Emblem window
label	string	false	Custom button text
className	string	false	Custom CSS class
style	object	false	Custom style object
assignCloseWindow	(closeFunc: () => void) => void	false	Allows implementers to receive a function that can be used to programmatically close the opened Emblem window on-demand

interface Props {
  url: string;
  projectKey: string;
  state: string;
  postbackUrl: string;
  postbackHeaders?: string;
  postbackOverride?: boolean; 
  onSuccessUrl?: string;
  onClickCallback?: () => void;
  label?: string;
  className?: string;
  style?: CSSProperties;
  assignCloseWindow?: (closeFunc: () => void) => void;
}