Skip to main content

Integrate SDKs

SDKs are distributed in our GitHub repositories:

Each distribution has a README.md file with more specific and extensive instructions on how to integrate it. Here, we will provide a minimal setup for the web SDK.

Example integration: web SDK

  1. Clone the repository.

    git clone https://github.com/MicroblinkPlatform/microblink-platform-browser-sdk
  2. Copy the package file (microblink-platform-sdk.tgz) to your project's directory and perform a local package install, for example using yarn or npm:

    cp microblink-platform-sdk.tgz path/to/my/project/
    cd path/to/my/project
    npm install ./microblink-platform-sdk.tgz
  3. Import and use the IdvFlow function in your project:

    import { IdvFlow } from '@microblink/platform-sdk/react';

    <IdvFlow
    workflowId="{id-of-workflow-to-use}"
    proxyConfig={{
    url: '{url-to-your-proxy-service}'
    }}
    onExit={() => {
    setShowIdvFlow(false);
    }}
    />