Vai al contenuto principale
ShieldID

SDKs

L'SDK per la verifica dell'identità e il percorso senza SDK.

La maggior parte delle integrazioni non ha bisogno di alcun SDK: il lavoro lo svolge la pagina ospitata. Il widget web serve quando desidera che il flusso resti all'interno della Sua pagina. Gli SDK mobile nativi sono i prossimi.

Il percorso senza SDK

La pagina ospitata non richiede alcun SDK, su qualsiasi piattaforma.

POST /v1/sessions restituisce un verification_url. Lo invii al richiedente nel modo in cui il Suo prodotto già invia i link (email, SMS, un reindirizzamento in-app, un codice QR su uno schermo) e ShieldID gestisce l'acquisizione, la prova di liveness e il selfie sul telefono del richiedente.

  • Funziona da un'app web, dal browser di sistema o dalla WebView di un'app nativa, da un link in un'email o da un codice QR su un chiosco: nulla da installare
  • Branding white-label sui piani idonei, così che non sembri un passaggio a una terza parte
  • I risultati Le arrivano tramite il reindirizzamento a return_url e il webhook firmato: non è necessario alcun collegamento di callback lato client

Il widget web

Incorpori il flusso nella Sua pagina.

Un piccolo script che mostra il flusso di verifica ospitato all'interno di un iframe nella Sua pagina, invece di allontanare il richiedente da essa.

Che cosa funziona oggi

  • TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) crea una sessione e la monta in un elemento a Sua scelta
  • Esegue lo stesso identico flusso di acquisizione della pagina ospitata, all'interno del Suo layout, con il Suo accentColor e il logo
  • Funziona già oggi per creare una sessione e mostrare il flusso inline

Callback di completamento

Prossimamente

onComplete, onCancel, onStep e il ridimensionamento automatico dell'iframe fanno parte dell'interfaccia del widget, ma al momento nulla all'interno del flusso li attiva. Non sviluppi logiche che dipendano dalla loro esecuzione: utilizzi invece il return URL e il webhook, entrambi funzionanti già oggi.

Una nota sulle chiavi API nel browser

La chiamata init() del widget è documentata come in grado di accettare un apiKey in chiaro nel JavaScript lato client. In produzione non lo consigliamo: chiunque visualizzi il sorgente ottiene la Sua chiave. Crei invece la sessione sul Suo backend con POST /v1/sessions e passi al widget il verification_url risultante da visualizzare: è la stessa raccomandazione del flusso ospitato, solo incorporato anziché collegato tramite link.

html
<div id="shieldid-verify"></div>
<!-- Exact script URL is published with your API keys; the path below is illustrative. -->
<script src="https://cdn.shieldid.ca/sdk/v1/widget.js"></script>
<script>
  // Recommended: create the session on your backend first (see API reference),
  // then pass its verification_url straight through — never a raw API key.
  TLVerify.init({
    containerId: "shieldid-verify",
    verificationUrl: "{{ session.verification_url }}", // from your backend
    theme: { accentColor: "#0B5CD8" },
  });
</script>

Mobile

Gli SDK nativi sono in arrivo.

Al momento non esiste un SDK per iOS o Android. Fino ad allora, apra la pagina di verifica ospitata nel browser di sistema della Sua app o in una WebView: è lo stesso flusso che utilizza un richiedente da web e funziona già oggi, su qualsiasi piattaforma su cui giri la Sua app.

ProssimamenteSDK nativi per iOS e Android

Scegliere il percorso

Tre modi per iniziare, messi a confronto con onestà.

Inizi dalla pagina ospitata, a meno che non abbia un motivo specifico per incorporare.

Cosa offre oggi ciascun percorso di integrazione.
FunzionalitàPagina ospitataWidget webSDK mobile
Nessun SDK, nessun codice lato clientSìNoProssimamente
Rimane all'interno della Sua paginaSi apre come linkiframe incorporatoProssimamente
Callback di completamento nel Suo codiceReturn URL + webhookProssimamenteProssimamente
Il Suo marchioSui piani idoneiSui piani idoneiProssimamente
Funziona oggiSìSìNo

Domande

FAQ su SDK e widget.

Inizi a sviluppare

La pagina ospitata è il modo più rapido per iniziare.

Una chiamata API, un link, nessun SDK necessario. Lo provi oggi stesso con una chiave sandbox.