Options

Une nouvelle intégration devrait utiliser Saphere Scan v2. Ce qui suit documente l’objet d’options de la v1.

Vos options sont validées, puis fusionnées par-dessus les valeurs par défaut — et par-dessus toute personnalisation appliquée par ?customizationId=. Les clés de premier niveau inconnues sont refusées plutôt qu’ignorées.

Premier niveau

createMeasure

Le widget a besoin d’une mesure à laquelle rattacher la capture. Il existe deux stratégies, et elles diffèrent par qui fait l’appel.

delegate — le widget appelle votre point d’accès

createMeasure: {
    strategy: "delegate",
    url: "/api/saphere-measure",
    headers: { "X-Session": sessionId }   // facultatif
}

Le widget émet POST <url> avec un corps JSON portant userData, desiredVariables et tags, et attend { "id": "<measureId>" } en retour.

Votre point d’accès authentifie votre utilisateur, appelle POST /measures sur l’API Saphere avec votre clé, et relaie l’identifiant.

handle — votre code fait l’appel

createMeasure: {
    strategy: "handle",
    fetch: async ({ userData, desiredVariables }) => {
        const response = await fetch("/api/saphere-measure", {
            method: "POST",
            headers: { "Content-Type": "application/json" },
            body: JSON.stringify({ userData, desiredVariables })
        })
        return await response.json()      // doit être { id: "…" }
    }
}

Si le point d’accès répond avec un statut hors 2xx, le widget lève Cannot create measure!.

onEvent

onEvent: async event => {
    console.log(event.type, event)
}

Appelée pour chaque événement ci-dessous. La valeur rendue est significative : rendre littéralement false annule la transition que l’événement annonce. Tout le reste — y compris undefined, et y compris une exception levée, qui est journalisée et avalée — l’autorise.

Le gestionnaire est attendu.

L’union des événements

Le reason de video-stream-loading vaut "denied", "no-device", "not-supported" ou "already-used".

Le reasons d’aborted porte soit un code de conformité (CONFORMITY_POOR_LIGHT, CONFORMITY_MUCH_VARIATIONS, CONFORMITY_FACE_PRESENCE, CONFORMITY_LOW_FPS, CREDIT_EXCEEDED, MISSING_USER_DATA_*, …), soit un motif d’échec (WIDGET_RESIZED, FOCUS_LOST, CANCELED_WHILE_CAPTURING, CREATE_MEASURE_ERROR, WS_CONNECTION_ERROR, VIDEO_SOURCE_ENDED, …).

Dans un événement result, chaque variable vaut { value, signals, error: null } en cas de succès, ou { value: null, error } en cas d’échec.

colors

Onze emplacements, chacun une chaîne hexadécimale (#RGB ou #RRGGBB). Les onze sont requis dès lors que vous fournissez l’objet.

Seules color01 et color02 servent à dériver d’autres teintes et nuances ; les autres sont appliquées telles quelles.

pages

Quels écrans apparaissent, et comment.

pages: {
    notice: { ignore: false },
    logo: { ignore: false, data: null },
    staticFacePlacement: { ignore: false },
    result: { ignore: false, titles: { ignore: false } },
    validates: {
        1: { ignore: false }, 2: { ignore: false },
        3: { ignore: true },  4: { ignore: false },
        5: { ignore: false }, 6: { ignore: false },
        7: { ignore: false }, 8: { ignore: false }
    }
}

Les huit écrans d’accueil

Les huit sont requis dès lors que vous fournissez validates.

L’écran 3 accepte un objet fields lorsqu’il est activé :

validates: {
    3: {
        ignore: false,
        fields: {
            height: { ignore: false },
            weight: { ignore: false },
            age: { ignore: false },
            sex: { ignore: false },
            smokingStatus: { ignore: false },
            externalId: { ignore: true }
        }
    }
}

Les six clés sont requises, et elles ne peuvent pas être toutes à ignore: true — un formulaire sans champ est refusé.

texts

Chaque chaîne visible par l’utilisateur, remplaçable par langue. L’objet doit porter les dix clés de langue — ar, de, en, es, fr, it, pl, pt, pt_BR, tr — et chacune est fusionnée par-dessus les chaînes intégrées, de sorte que vous ne remplacez que ce que vous nommez.

texts: {
    ...Handler.defaultModuleOptions.texts,
    fr: {
        ...Handler.defaultModuleOptions.texts.fr,
        button: { next: "Continuer" }
    }
}

Étaler les valeurs par défaut est la façon pratique de satisfaire l’exigence sans réécrire dix langues à la main.