Ionic
Integrate the Human Token Journey into your Ionic app using a Capacitor plugin.
The integration uses a local Capacitor plugin that delegates to Custom Tabs on Android and ASWebAuthenticationSession on iOS. When the journey finishes, the deep link returns through @capacitor/app.
Prerequisites
- Ionic with Capacitor v4+
@capacitor/appinstalled- Xcode 14+ and Android Studio
- A unique URL scheme for your app (e.g.
myapp)
Step 1: Define your URL scheme
Choose a unique scheme (e.g. myapp). This is used as the callbackUri when creating the process:
callbackUri: myapp://callback
Step 2: Create the Capacitor plugin interface
import { registerPlugin } from '@capacitor/core';
export interface UnicoPlugin {
openSession(options: { url: string }): Promise<{ callbackUrl: string }>;
}
const Unico = registerPlugin<UnicoPlugin>('UnicoPlugin');
export default Unico;
Step 3: Implement the iOS plugin
import Capacitor
import AuthenticationServices
@objc(UnicoPlugin)
public class UnicoPlugin: CAPPlugin, ASWebAuthenticationPresentationContextProviding {
private var session: ASWebAuthenticationSession?
@objc func openSession(_ call: CAPPluginCall) {
guard let urlString = call.getString("url"),
let url = URL(string: urlString) else {
call.reject("Invalid URL")
return
}
DispatchQueue.main.async {
let newSession = ASWebAuthenticationSession(
url: url,
callbackURLScheme: "myapp"
) { callbackURL, error in
self.session = nil
if let callbackURL = callbackURL {
call.resolve(["callbackUrl": callbackURL.absoluteString])
} else {
call.reject(error?.localizedDescription ?? "Session cancelled")
}
}
newSession.presentationContextProvider = self
newSession.prefersEphemeralWebBrowserSession = true
newSession.start()
self.session = newSession
}
}
public func presentationAnchor(for session: ASWebAuthenticationSession) -> ASPresentationAnchor {
guard let windowScene = UIApplication.shared.connectedScenes.first as? UIWindowScene,
let window = windowScene.windows.first else {
return ASPresentationAnchor()
}
return window
}
}
Step 4: Implement the Android plugin
import android.content.Intent
import android.net.Uri
import androidx.browser.customtabs.CustomTabsIntent
import com.getcapacitor.Plugin
import com.getcapacitor.PluginCall
import com.getcapacitor.PluginMethod
import com.getcapacitor.annotation.CapacitorPlugin
@CapacitorPlugin(name = "UnicoPlugin")
class UnicoPlugin : Plugin() {
private var pendingCall: PluginCall? = null
@PluginMethod
fun openSession(call: PluginCall) {
val url = call.getString("url") ?: return call.reject("Missing URL")
pendingCall = call
activity.runOnUiThread {
CustomTabsIntent.Builder().build()
.launchUrl(activity, Uri.parse(url))
}
}
override fun handleOnNewIntent(intent: Intent) {
super.handleOnNewIntent(intent)
intent.data?.let { uri ->
if (uri.scheme == "myapp") {
pendingCall?.resolve(com.getcapacitor.JSObject().put("callbackUrl", uri.toString()))
pendingCall = null
}
}
}
}
Step 5: Configure URL schemes
- iOS
- Android
Add to Info.plist:
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLSchemes</key>
<array>
<string>myapp</string>
</array>
</dict>
</array>
Add to AndroidManifest.xml inside your main <activity>:
<intent-filter>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
<data android:scheme="myapp" android:host="callback" />
</intent-filter>
Add to build.gradle:
implementation("androidx.browser:browser:1.5.0")
Step 6: Create the Angular service
import { Injectable } from '@angular/core';
import Unico from '../plugins/unico-plugin';
@Injectable({ providedIn: 'root' })
export class UnicoService {
async openSession(url: string): Promise<string | null> {
try {
const result = await Unico.openSession({ url });
const params = new URL(result.callbackUrl).searchParams;
return params.get('id');
} catch {
return null;
}
}
}
Step 7: Listen for deep links
In your AppComponent:
import { App } from '@capacitor/app';
App.addListener('appUrlOpen', (event) => {
// Handle the callback URL if needed
console.log('Deep link received:', event.url);
});
File summary
| File | Purpose |
|---|---|
unico-plugin.ts | Capacitor plugin interface |
UnicoPlugin.swift | iOS — ASWebAuthenticationSession |
UnicoPlugin.kt | Android — Custom Tabs |
Info.plist | iOS URL scheme |
AndroidManifest.xml | Android intent filter |
unico.service.ts | Angular service wrapper |