Introduction

Prev Next

The Cordova App SDK enables you to write apps using strong authentication. These apps can run on Android and iOS devices as well as web browsers. The API interface is identical to that of the Web App SDK. On mobile, the API accesses the native FIDO functionality. For a web app, the API accesses the Web Authentication capabilities of the browser. Comparing Functionality on Different Platforms summarises the differences between the Web App SDK and Cordova App SDK.

By using this Guide, you learn how to:

  • Integrate a mobile app with the Nok Nok Authentication Server

  • Deliver strong authentication on FIDO Ready™ and FIDO Certified™ devices

  • Support non-FIDO Ready and non-FIDO Certified devices

The Cordova App SDK consists of the following plugins:

  • plugin_appsdk provides strong authentication using the Nok Nok™ App SDK and FIDO. This plugin contains all of the code to use the Nok Nok JS API.

  • plugin_appsdk_oob (optional) provides out-of-band (OOB) authentication as a second device using native layer functionality. This plugin requires the plugin_appsdk and the plugin_appsdk_plus to work.

  • plugin_appsdk_plus (optional) contains deprecated APIs that should not be called directly from the app, but this plugin is required by the plugin_appsdk_oob.

  • plugin_appsdk_hms (optional) provides components required to receive and handle push notifications on Android Huawei devices. This plugin requires plugin_appsdk_oob.

The Cordova App SDK is used with the following Nok Nok App SDK versions. These are automatically included when you install the Cordova App SDK.

  • Android App SDK 9.4.0

  • iOS App SDK 9.4.0

For additional platform dependencies, see https://cordova.apache.org/#getstarted

Overview

The major topics covered here fall into the following areas:

Client API documentation

There are two ways to access the client API docs for the Cordova App SDK:

  1. Download and host on your local computer:
    The standard automatically-generated API documentation for the App SDK is in the Nok Nok Cordova API deployment package: nn_cordova_app_sdk_9.4.0.<build_number>.zip. Use the following directories:

    • docs/jssdk contains the client API documentation for the Web App SDK, which is used by the Cordova App SDK.

    • docs/plugin_appsdk_plus contains the client API documentation for deprecated APIs.

  2. Access from the Nok Nok Authentication Cloud:

    1. If you are already logged into cloud.noknok.com: Click the following link
      Web App SDK API Docs

    2. If you are not already logged into cloud.noknok.com: Log in and locate the Documentation tile, then click more.

      Choose Nok Nok Web App SDK API Docs 9.4.

Comparing functionality on different platforms

The Cordova SDK has slightly different behaviour from the Web App SDK on the Web.

Cordova

Web

Registration, Authentication, Transaction Confirmation, and Managing Registrations

Accepted

Accepted

Accepted

Accepted

UAF Protocol

Accepted

Accepted

Rejected

Rejected

FIDO2 Protocol

Accepted

Accepted

Accepted

Accepted

OOB as 1st device

(display QR code, send push)

Accepted

Accepted

Accepted

Accepted

OOB as 2nd device (scan QR code, receive push)

Accepted

Accepted

Accepted

Accepted

Managing Personally Identifiable Information

Accepted

Accepted

Accepted

Accepted

App-less QR OOB Support

Accepted

Accepted

Accepted

Accepted

Secure Payment Confirmation (SPC)

Rejected

Rejected

Accepted

Accepted

Use of App SDK iframe

Rejected

Rejected

Accepted

Accepted